IBDA_Topology::GetNodeDescriptors Method

The GetNodeDescriptors method retrieves a list of descriptors for the nodes in the topology.

Syntax

HRESULT GetNodeDescriptors(
  [in, out]  ULONG *ulcNodeDescriptors,
  [in]       ULONG ulcNodeDescriptorsMax,
  [in, out]  BDANODE_DESCRIPTOR rgNodeDescriptors[]
);

Parameters

• ulcNodeDescriptors [in, out]
  Receives a count of the number of node descriptors written to the rgNodeDescriptors array.

• ulcNodeDescriptorsMax [in]
  Specifies the maximum number of node descriptors that the rgNodeDescriptors array can hold.

• rgNodeDescriptors [in, out]
  Pointer to a buffer that receives an array of node descriptors. Each node descriptor is a structure of type BDANODE_DESCRIPTOR.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Requirements

See Also

Error and Success Codes
IBDA_Topology Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008