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。 如果失败,可能的返回代码包括但不限于下表中显示的值。

返回代码 说明
E_INVALIDARG
参数 nJack 不是有效的插孔索引。
E_POINTER
指针 pDescriptionNULL

注解

当用户需要将音频终结点设备插入插孔或将其从插孔中拔下时,音频应用程序可以使用它从此方法检索的描述性信息来帮助用户查找插孔。 此信息包括:

  • 插孔在计算机机箱或外部盒上的物理位置。
  • 插孔的颜色。
  • 用于插孔的物理连接器的类型。
  • 通道到插孔的映射。
有关详细信息,请参阅 KSJACK_DESCRIPTION

要求

要求
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 devicetopology.h

另请参阅

IKsJackDescription 接口

IKsJackDescription::GetJackCount

KSJACK_DESCRIPTION