Add Method of the IFPCRdlReportParameterInstances Interface

  • Article

The Add method creates a new FPCRdlReportParameterInstance object in the collection and returns a reference to it.

C++

Syntax

HRESULT Add(
  [in]   BSTR Name,
  [in]   BSTR RdlCategoryName,
  [in]   BSTR RdlReportName,
  [in]   BSTR RdlParameterName,
  [out]  IFPCRdlReportParameterInstance** ppNewRdlReportRef
);

Parameters

  • Name
    Required. BSTR that specifies the name of the new instance of a Report Definition Language (RDL) report parameter.

  • RdlCategoryName
    Required. BSTR that specifies the name of the RDL report category to be referenced by the new instance.

  • RdlReportName
    Required. BSTR that specifies the name of the RDL report definition to be referenced by the new instance.

  • RdlParameterName
    Required. BSTR that specifies the name of the RDL report parameter to be referenced by the new instance.

  • ppNewRdlReportRef
    Address of an interface pointer that on return points to the new IFPCRdlReportParameterInstance interface created.

Return Value

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

Visual Basic

Syntax

Function Add( _
  ByVal Name As String, _
  ByVal RdlCategoryName As String, _
  ByVal RdlReportName As String, _
  ByVal RdlParameterName As String _
) As FPCRdlReportParameterInstance

Parameters

  • Name
    Required. String that specifies the name of the new instance of a Report Definition Language (RDL) report parameter.

  • RdlCategoryName
    Required. String that specifies the name of the RDL report category to be referenced by the new instance.

  • RdlReportName
    Required. String that specfies the name of the RDL report definition to be referenced by the new instance.

  • RdlParameterName
    Required. String that specifies the name of the RDL report parameter to be referenced by the new instance.

Return Value

This method returns a reference to the FPCRdlReportParameterInstance object created if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.
DLL

Requires Msfpccom.dll.

See Also

FPCRdlReportParameterInstances

Send comments about this topic to Microsoft

Build date: 6/30/2010