IKsJackDescription2::GetJackDescription2 method
The GetJackDescription2 method gets the description of a specified audio jack.
Syntax
HRESULT GetJackDescription2(
[in] UINT nJack,
[out] KSJACK_DESCRIPTION2 *pDescription2
);
Parameters
- nJack [in]
-
The index of the jack to get a description for. 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.
- pDescription2 [out]
-
Pointer to a caller-allocated buffer into which the method writes a structure of type KSJACK_DESCRIPTION2 that contains information about the jack. The buffer size must be at least
sizeof(KSJACK_DESCRIPTION2).
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 |
|---|---|
|
Parameter nJack is not a valid jack index. |
|
Pointer pDescription is NULL. |
Requirements
|
Minimum supported client |
Windows 7 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 R2 [desktop apps only] |
|
Header |
|
See also