Share via

3.1.4.1.2 GetComponentDataByContainer (Opnum 5)

  • Article

A client calls this method to obtain tracking information for components that have one or more component instances in a given instance container.

 HRESULT GetComponentDataByContainer(
   [in] DWORD idContainer,
   [out] DWORD* nComponents,
   [out, size_is(,*nComponents)] ComponentData** aComponentData
 );

idContainer: The container legacy identifier of an instance container.

nComponents: A pointer to a variable that, upon successful completion, MUST contain the number of elements in aComponentData.

aComponentData: A pointer to a variable that, upon successful completion, MUST contain an array of zero or more ComponentData (section 2.2.4) structures. An array with zero elements MUST be represented by null.

Return Values: This method MUST return S_OK (0x00000000) on success and a failure result (as specified in [MS-ERREF] section 2.1) on failure.

When this method is invoked, the server MUST verify that the idContainer parameter identifies a tracked instance container and fail the call if not. The server then MUST attempt to return an array of zero or more ComponentData structures, one for each distinct component instance instantiated in the instance container, and fail the call if it cannot.