AddParameterInstance Method of the IFPCEEReportJob2 Interface

  • Article

The AddParameterInstance method adds an instance of an Report Definition Language (RDL) report parameter to the report job.

C++

Syntax

HRESULT AddParameterInstance(
  [in]  BSTR bstrName,
  [in]  BSTR bstrCategoryName,
  [in]  BSTR bstrRdlName,
  [in]  BSTR bstrParameterName,
  [in]  BSTR bstrParameterValue
);

Parameters

  • bstrName
    Required. BSTR that specifies the name of the new instance of the RDL report parameter.

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

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

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

  • bstrParameterValue
    Required. BSTR that specifies the value of the new instance of the RDL report parameter.

Return Value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

Visual Basic

Syntax

Sub AddParameterInstance( _
  ByVal bstrName As String, _
  ByVal bstrCategoryName As String, _
  ByVal bstrRdlName As String, _
  ByVal bstrParameterName As String, _
  ByVal bstrParameterValue As String _
)

Parameters

  • bstrName
    Required. BSTR that specifies the name of the new instance of the RDL report parameter.

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

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

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

  • bstrParameterValue
    Required. String that specifies the value of the new instance of the RDL report parameter.

Return Value

This method has no return values. If the call is unsuccessful, 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

FPCReportJob

Send comments about this topic to Microsoft

Build date: 6/30/2010