IBDA_Topology::GetNodeDescriptors method (bdaiface.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

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

[in, out] ulcNodeDescriptors

Receives a count of the number of node descriptors written to the rgNodeDescriptors array.

[in] ulcNodeDescriptorsMax

Specifies the maximum number of node descriptors that the rgNodeDescriptors array can hold.

[in, out] rgNodeDescriptors

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