Compartilhar via

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

  • Artigo

O GetFormatRepresentation método recupera uma representação de cadeia de caracteres do formato personalizado para que ele possa ser exibido em uma interface do usuário.

Sintaxe

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

Parâmetros

[in] nFormat

Especifica o índice de um formato com suporte. Esse parâmetro pode ser qualquer valor no intervalo de zero a um menor que o valor retornado de GetFormatCount. Em outras palavras, qualquer valor no intervalo de zero a GetFormatCount( ) – 1.

[out, optional] ppwstrFormatRep

Especifica o endereço do buffer que recebe uma cadeia de caracteres Unicode terminada em NULL que descreve o formato personalizado.

Retornar valor

O GetFormatRepresentation método retorna S_OK quando a chamada é bem-sucedida. Caso contrário, ele retornará um dos códigos de erro mostrados na tabela a seguir.

Código de retorno Descrição
E_POINTER
 Ponteiro inválido passado para a função
E_OUTOFMEMORY
 O buffer de retorno não pode ser alocado
E_INVALIDARG
 nFormat está fora do intervalo

Comentários

O sAPO usa CoTaskMemAlloc para alocar a cadeia de caracteres retornada. O chamador deve usar CoTaskMemFree para excluir o buffer apontado pelo parâmetro ppwstrFormatRep .

Requisitos

Requisito Valor
Cliente mínimo com suporte Disponível no Windows Vista e versões posteriores do Windows.
Plataforma de Destino Área de Trabalho
Cabeçalho audioenginebaseapo.h (inclua Audioenginebaseapo.h)
IRQL Todos os níveis.

Confira também

Cotaskmemalloc

Cotaskmemfree

GetFormatCount