Metode IKsJackDescription::GetJackDescription (devicetopology.h)

Metode GetJackDescription mendapatkan deskripsi jack audio.

Sintaks

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

Parameter

[in] nJack

Indeks jack. Jika koneksi terdiri dari n jack, jack dinomor dari 0 hingga n– 1. Untuk mendapatkan jumlah jack, panggil metode IKsJackDescription::GetJackCount .

[out] pDescription

Arahkan ke buffer yang dialokasikan penelepon tempat metode menulis struktur jenis KSJACK_DESCRIPTION yang berisi informasi tentang jack. Ukuran buffer harus setidaknya ukuranof(KSJACK_DESCRIPTION).

Nilai kembali

Jika metode berhasil, metode akan mengembalikan S_OK. Jika gagal, kemungkinan kode pengembalian menyertakan, tetapi tidak terbatas pada, nilai yang diperlihatkan dalam tabel berikut.

Menampilkan kode Deskripsi
E_INVALIDARG
Parameter nJack bukan indeks jack yang valid.
E_POINTER
Pointer pDescription adalah NULL.

Keterangan

Ketika pengguna perlu menyambungkan perangkat titik akhir audio ke jack atau men cabut dari jack, aplikasi audio dapat menggunakan informasi deskriptif yang diambilnya dari metode ini untuk membantu pengguna menemukan jack. Informasi ini mencakup:

  • Lokasi fisik jack pada sasis komputer atau kotak eksternal.
  • Warna jack.
  • Jenis konektor fisik yang digunakan untuk jack.
  • Pemetaan saluran ke jack.
Untuk informasi selengkapnya, lihat KSJACK_DESCRIPTION.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2008 [hanya aplikasi desktop]
Target Platform Windows
Header devicetopology.h

Lihat juga

Antarmuka IKsJackDescription

IKsJackDescription::GetJackCount

KSJACK_DESCRIPTION