IAudioSystemEffectsCustomFormats::GetFormatRepresentation-Methode (audioenginebaseapo.h)
Die GetFormatRepresentation -Methode ruft eine Zeichenfolgendarstellung des benutzerdefinierten Formats ab, sodass sie auf einer Benutzeroberfläche angezeigt werden kann.
Syntax
HRESULT GetFormatRepresentation(
[in] UINT nFormat,
[out, optional] LPWSTR *ppwstrFormatRep
);
Parameter
[in] nFormat
Gibt den Index eines unterstützten Formats an. Dieser Parameter kann ein beliebiger Wert im Bereich von null bis 1 kleiner als der Rückgabewert von GetFormatCount sein. Mit anderen Worten, ein beliebiger Wert im Bereich von 0 bis GetFormatCount( ) - 1.
[out, optional] ppwstrFormatRep
Gibt die Adresse des Puffers an, der eine MIT NULL beendete Unicode-Zeichenfolge empfängt, die das benutzerdefinierte Format beschreibt.
Rückgabewert
Die GetFormatRepresentation Methode gibt S_OK zurück, wenn der Aufruf erfolgreich ist. Andernfalls wird einer der Fehlercodes zurückgegeben, die in der folgenden Tabelle dargestellt sind.
| Rückgabecode | Beschreibung |
|---|---|
|
Ungültiger Zeiger an Funktion übergeben |
|
Rückgabepuffer kann nicht zugeordnet werden |
|
nFormat liegt außerhalb des Bereichs |
Hinweise
Die sAPO verwendet CoTaskMemAlloc , um die zurückgegebene Zeichenfolge zuzuordnen. Der Aufrufer muss CoTaskMemFree verwenden, um den Puffer zu löschen, auf den der ppwstrFormatRep-Parameter verweist.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Verfügbar in Windows Vista und späteren Windows-Versionen. |
| Zielplattform | Desktop |
| Kopfzeile | audioenginebaseapo.h (include Audioenginebaseapo.h) |
| IRQL | Alle Ebenen. |