iKsJackDescription::GetJackDescription 方法 (devicetopology.h)
GetJackDescription 方法會取得音訊插孔的描述。
語法
HRESULT GetJackDescription(
[in] UINT nJack,
[out] KSJACK_DESCRIPTION *pDescription
);
參數
[in] nJack
插孔索引。 如果連接是由 n 個插孔所組成,則插孔會從 0 編號為 n– 1。 若要取得插孔數目,請呼叫 IKsJackDescription::GetJackCount 方法。
[out] pDescription
呼叫端配置的緩衝區指標,該方法會將類型 為 KSJACK_DESCRIPTION 的結構寫入,其中包含插孔的相關信息。 緩衝區大小必須至少為 (KSJACK_DESCRIPTION) 大小。
傳回值
如果方法成功,它會傳回 S_OK。 如果失敗,可能的傳回碼包括但不限於下表所示的值。
傳回碼 | Description |
---|---|
|
參數 nJack 不是有效的插孔索引。 |
|
指標 pDescription 為 NULL。 |
備註
當使用者需要將音訊端點裝置插入插孔或從插孔中拔除時,音訊應用程式可以使用從這個方法擷取的描述性資訊,協助使用者尋找插孔。 此資訊包括:
- 計算機底座或外部方塊上插孔的實體位置。
- 插孔的色彩。
- 用於插孔的實體連接器類型。
- 通道與插孔的對應。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | devicetopology.h |