IDeviceTopology::GetConnector method

The GetConnector method gets the connector that is specified by a connector number.

Syntax


HRESULT GetConnector(
  [in]  UINT       nIndex,
  [out] IConnector **ppConnector
);

Parameters

nIndex [in]

The connector number. If a device topology contains n connectors, the connectors are numbered 0 to n – 1. To get the number of connectors in the device topology, call the IDeviceTopology::GetConnectorCount method.

ppConnector [out]

Pointer to a pointer variable into which the method writes the address of the IConnector interface of the connector object. Through this method, the caller obtains a counted reference to the interface. The caller is responsible for releasing the interface, when it is no longer needed, by calling the interface's Release method. If the GetConnector call fails, *ppConnector is NULL.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return codeDescription
E_INVALIDARG

Parameter nIndex is out of range.

E_POINTER

Pointer ppConnector is NULL.

 

Remarks

For code examples that call the GetConnector method, see the implementations of the GetHardwareDeviceTopology and SelectCaptureDevice functions in Device Topologies.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Devicetopology.h

See also

IConnector Interface
IDeviceTopology Interface
IDeviceTopology::GetConnectorCount

 

 

Show: