Edit

IFsrmPipelineModuleImplementation::OnLoad method (fsrmpipeline.h)

  • Article

Initializes the pipeline module.

Syntax

HRESULT OnLoad(
  [in]  IFsrmPipelineModuleDefinition *moduleDefinition,
  [out] IFsrmPipelineModuleConnector  **moduleConnector
);

Parameters

[in] moduleDefinition

Type: IFsrmPipelineModuleDefinition*

An IFsrmPipelineModuleDefinition instance representing the pipeline module definition to use.

[out] moduleConnector

Type: IFsrmPipelineModuleConnector**

An IFsrmPipelineModuleConnector instance representing the pipeline module connector to use.

Return value

Type: HRESULT

The method returns the following return values.

Other values will result in the client application receiving a FSRM_E_UNEXPECTEDFSRM_E_MODULE_SESSION_INITIALIZATION error.

Windows Server 2008 R2:  The client application will receive a FSRM_E_UNEXPECTED error.

Remarks

Your OnLoad implementation must create and bind to an instance of an object implementing the IFsrmPipelineModuleConnector interface and return it in the moduleConnector parameter. For more information on how to create and bind this instance, see Initializing and Binding a Pipeline Module.

Examples

See Developing FCI Pipeline Modules.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2
Target Platform Windows
Header fsrmpipeline.h
DLL SrmSvc.dll

See also

IFsrmClassifierModuleImplementation

IFsrmPipelineModuleImplementation

IFsrmStorageModuleImplementation