Método IAudioSystemEffectsCustomFormats::GetFormatRepresentation (audioenginebaseapo.h)

  • Artículo

El GetFormatRepresentation método recupera una representación de cadena del formato personalizado para que se pueda mostrar en una interfaz de usuario.

Sintaxis

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

Parámetros

[in] nFormat

Especifica el índice de un formato admitido. Este parámetro puede ser cualquier valor del intervalo de cero a uno menor que el valor devuelto de GetFormatCount. Es decir, cualquier valor del intervalo de cero a GetFormatCount( ) - 1.

[out, optional] ppwstrFormatRep

Especifica la dirección del búfer que recibe una cadena Unicode terminada en NULL que describe el formato personalizado.

Valor devuelto

El GetFormatRepresentation método devuelve S_OK cuando la llamada se realiza correctamente. De lo contrario, devuelve uno de los códigos de error que se muestran en la tabla siguiente.

Código devuelto Descripción
E_POINTER
 Puntero no válido pasado a la función
E_OUTOFMEMORY
 No se puede asignar el búfer de devolución
E_INVALIDARG
 nFormat está fuera del intervalo

Comentarios

El sAPO usa CoTaskMemAlloc para asignar la cadena devuelta. El llamador debe usar CoTaskMemFree para eliminar el búfer al que apunta el parámetro ppwstrFormatRep .

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Windows Vista y versiones posteriores de Windows.
Plataforma de destino Escritorio
Encabezado audioenginebaseapo.h (incluya Audioenginebaseapo.h)
IRQL Todos los niveles.

Consulte también

CoTaskMemAlloc

CoTaskMemFree

GetFormatCount