Método IKsFormatSupport::GetDevicePreferredFormat (devicetopology.h)

O método GetDevicePreferredFormat obtém o formato de fluxo de áudio preferencial para a conexão.

Sintaxe

HRESULT GetDevicePreferredFormat(
  [out] PKSDATAFORMAT *ppKsFormat
);

Parâmetros

[out] ppKsFormat

Ponteiro para uma variável de ponteiro na qual o método grava o endereço de um buffer que contém o especificador de formato para o formato preferencial. O especificador começa com uma estrutura KSDATAFORMAT que pode ser seguida por informações de formato adicionais. O método aloca o armazenamento para o especificador de formato. O chamador é responsável por liberar o armazenamento, quando ele não é mais necessário, chamando a função CoTaskMemFree . Se o método falhar, *ppKsFormat será NULL. Para obter mais informações sobre KSDATAFORMAT, especificadores de formato e CoTaskMemFree, consulte a documentação do DDK do Windows.

Retornar valor

Se o método for bem-sucedido, retornará S_OK. Se falhar, os códigos de retorno possíveis incluem, mas não se limitam a, os valores mostrados na tabela a seguir.

Código de retorno	Descrição
E_POINTER	O ponteiro ppKsFormat é NULL.
E_OUTOFMEMORY	Sem memória.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	devicetopology.h

Confira também

IKsFormatSupport Interface