IKsJackDescription::GetJackDescription method (devicetopology.h)

Article
02/22/2024

The GetJackDescription method gets a description of an audio jack.

Syntax

HRESULT GetJackDescription(
  [in]  UINT               nJack,
  [out] KSJACK_DESCRIPTION *pDescription
);

Parameters

[in] nJack

The jack index. If the connection consists of n jacks, the jacks are numbered from 0 to n– 1. To get the number of jacks, call the IKsJackDescription::GetJackCount method.

[out] pDescription

Pointer to a caller-allocated buffer into which the method writes a structure of type KSJACK_DESCRIPTION that contains information about the jack. The buffer size must be at least sizeof(KSJACK_DESCRIPTION).

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 code	Description
E_INVALIDARG	Parameter nJack is not a valid jack index.
E_POINTER	Pointer pDescription is NULL.

Remarks

When a user needs to plug an audio endpoint device into a jack or unplug it from a jack, an audio application can use the descriptive information that it retrieves from this method to help the user to find the jack. This information includes:

The physical location of the jack on the computer chassis or external box.
The color of the jack.
The type of physical connector used for the jack.
The mapping of channels to the jack.

For more information, see KSJACK_DESCRIPTION.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	devicetopology.h