3.2.4.2.43.18 Parameters (get) (Opnum 29)

  • Article

The Parameters (get) method retrieves the Parameters of the pipeline module definition and returns S_OK upon successful completion.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_PIPELINE_MODULE_DEFINITION | 0xA))] HRESULT Parameters(
   [out, retval] SAFEARRAY(VARIANT)* parameters
 );

parameters: Pointer to a variable that upon completion contains the Parameters of the pipeline module definition.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

The parameters parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that parameters is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

The server MUST set the parameters array to the list of Module Definition.Parameters for the module definition. See parameter strings in section 3.2.4.2 for more details on the format of the elements of the array retrieved.