Méthode IAudioSystemEffectsCustomFormats ::GetFormatRepresentation (audioenginebaseapo.h)
La GetFormatRepresentation méthode récupère une représentation sous forme de chaîne du format personnalisé afin qu’elle puisse être affichée sur une interface utilisateur.
Syntaxe
HRESULT GetFormatRepresentation(
[in] UINT nFormat,
[out, optional] LPWSTR *ppwstrFormatRep
);
Paramètres
[in] nFormat
Spécifie l’index d’un format pris en charge. Ce paramètre peut être n’importe quelle valeur de la plage comprise entre zéro et une valeur inférieure à la valeur de retour de GetFormatCount. En d’autres termes, toute valeur comprise entre zéro et GetFormatCount( ) - 1.
[out, optional] ppwstrFormatRep
Spécifie l’adresse de la mémoire tampon qui reçoit une chaîne Unicode terminée par NULL qui décrit le format personnalisé.
Valeur retournée
La GetFormatRepresentation méthode retourne S_OK lorsque l’appel réussit. Sinon, il retourne l’un des codes d’erreur indiqués dans le tableau suivant.
| Code de retour | Description |
|---|---|
|
Pointeur non valide passé à la fonction |
|
Impossible d’allouer la mémoire tampon de retour |
|
nFormat est hors de portée |
Remarques
L’objet sAPO utilise CoTaskMemAlloc pour allouer la chaîne retournée. L’appelant doit utiliser CoTaskMemFree pour supprimer la mémoire tampon vers laquelle pointe le paramètre ppwstrFormatRep .
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Disponible dans Windows Vista et les versions plus récentes de Windows. |
| Plateforme cible | Desktop (Expérience utilisateur) |
| En-tête | audioenginebaseapo.h (inclure Audioenginebaseapo.h) |
| IRQL | Tous les niveaux. |