Metodo IAudioSystemEffectsCustomFormats::GetFormatRepresentation (audioenginebaseapo.h)

Articolo
02/23/2024

Il GetFormatRepresentation metodo recupera una rappresentazione stringa del formato personalizzato in modo che possa essere visualizzato in un'interfaccia utente.

Sintassi

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

Parametri

[in] nFormat

Specifica l'indice di un formato supportato. Questo parametro può essere qualsiasi valore nell'intervallo da zero a uno minore del valore restituito di GetFormatCount. In altre parole, qualsiasi valore nell'intervallo da zero a GetFormatCount( ) - 1.

[out, optional] ppwstrFormatRep

Specifica l'indirizzo del buffer che riceve una stringa Unicode con terminazione NULL che descrive il formato personalizzato.

Valore restituito

Il GetFormatRepresentation metodo restituisce S_OK quando la chiamata ha esito positivo. In caso contrario, restituisce uno dei codici di errore illustrati nella tabella seguente.

Codice restituito	Descrizione
E_POINTER	Puntatore non valido passato alla funzione
E_OUTOFMEMORY	Impossibile allocare il buffer restituito
E_INVALIDARG	nFormat non è compreso nell'intervallo

Commenti

SAPO usa CoTaskMemAlloc per allocare la stringa restituita. Il chiamante deve usare CoTaskMemFree per eliminare il buffer a cui punta il parametro ppwstrFormatRep .

Requisiti

Requisito	Valore
Client minimo supportato	Disponibile in Windows Vista e versioni successive di Windows.
Piattaforma di destinazione	Desktop
Intestazione	audioenginebaseapo.h (includere Audioenginebaseapo.h)
IRQL	Tutti i livelli.

Vedi anche

Cotaskmemalloc

CoTaskMemFree

GetFormatCount

Condividi tramite