IAudioSystemEffectsCustomFormats::Metode GetFormatRepresentation (audioenginebaseapo.h)

Artikel
02/26/2024

Metode ini GetFormatRepresentation mengambil representasi string dari format kustom sehingga dapat ditampilkan pada antarmuka pengguna.

Sintaks

HRESULT GetFormatRepresentation(
  [in]            UINT   nFormat,
  [out, optional] LPWSTR *ppwstrFormatRep
);

Parameter

[in] nFormat

Menentukan indeks format yang didukung. Parameter ini dapat berupa nilai apa pun dalam rentang dari nol hingga satu kurang dari nilai yang dikembalikan getFormatCount. Dengan kata lain, nilai apa pun dalam rentang dari nol hingga GetFormatCount( ) - 1.

[out, optional] ppwstrFormatRep

Menentukan alamat buffer yang menerima string Unicode yang dihentikan NULL yang menjelaskan format kustom.

Menampilkan nilai

Metode GetFormatRepresentation mengembalikan S_OK ketika panggilan berhasil. Jika tidak, kode kesalahan akan menampilkan salah satu kode kesalahan yang diperlihatkan dalam tabel berikut.

Menampilkan kode	Deskripsi
E_POINTER	Penunjuk tidak valid diteruskan ke fungsi
E_OUTOFMEMORY	Buffer pengembalian tidak dapat dialokasikan
E_INVALIDARG	nFormat di luar rentang

Keterangan

SAPO menggunakan CoTaskMemAlloc untuk mengalokasikan string yang dikembalikan. Pemanggil harus menggunakan CoTaskMemFree untuk menghapus buffer yang diarahkan oleh parameter ppwstrFormatRep .

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows Vista dan versi Windows yang lebih baru.
Target Platform	Desktop
Header	audioenginebaseapo.h (termasuk Audioenginebaseapo.h)
IRQL	Semua tingkatan.

Lihat juga

CoTaskMemAlloc

CoTaskMemFree

GetFormatCount

Bagikan melalui