Função SetupDiGetClassDevPropertySheetsA (setupapi.h)

Artigo
11/20/2024

A função SetupDiGetClassDevPropertySheets recupera identificadores para as folhas de propriedades de um elemento de informações do dispositivo ou da classe de instalação do dispositivo de um conjunto de informações do dispositivo.

Sintaxe

WINSETUPAPI BOOL SetupDiGetClassDevPropertySheetsA(
  [in]            HDEVINFO           DeviceInfoSet,
  [in, optional]  PSP_DEVINFO_DATA   DeviceInfoData,
  [in]            LPPROPSHEETHEADERA PropertySheetHeader,
  [in]            DWORD              PropertySheetHeaderPageListSize,
  [out, optional] PDWORD             RequiredSize,
  [in]            DWORD              PropertySheetType
);

Parâmetros

[in] DeviceInfoSet

Um identificador para o conjunto de informações do dispositivo para o qual retornar identificadores de folha de propriedades. Se DeviceInfoData não especificar um elemento de informações do dispositivo no conjunto de informações do dispositivo, o conjunto de informações do dispositivo deverá ter uma classe de instalação de dispositivo associada.

[in, optional] DeviceInfoData

Um ponteiro para uma estrutura SP_DEVINFO_DATA que especifica um elemento de informações do dispositivo no DeviceInfoSet.

Esse parâmetro é opcional e pode ser NULL. Se esse parâmetro for especificado, SetupDiGetClassDevPropertySheets recuperará os identificadores de folhas de propriedades associados ao dispositivo especificado. Se esse parâmetro for NULL, SetupDiGetClassDevPropertySheets recuperará os identificadores de folhas de propriedades associados à classe de instalação do dispositivo especificada em DeviceInfoSet.

[in] PropertySheetHeader

Um ponteiro para uma estrutura PROPERTYSHEETHEADER. Consulte a seção Comentários para obter informações sobre a matriz fornecida pelo chamador de identificadores de folha de propriedades que está associada a essa estrutura.

Para obter mais documentação sobre essa estrutura e folhas de propriedades em geral, consulte o SDK do Microsoft Windows.

[in] PropertySheetHeaderPageListSize

O número máximo de identificadores que a matriz fornecida pelo chamador de identificadores de folha de propriedades pode conter.

[out, optional] RequiredSize

Um ponteiro para uma variável do tipo DWORD que recebe o número de folhas de propriedades associadas ao elemento de informações do dispositivo especificado ou à classe de configuração do dispositivo do conjunto de informações do dispositivo especificado. O ponteiro é opcional e pode ser NULL.

[in] PropertySheetType

Um sinalizador que indica um dos seguintes tipos de folhas de propriedades.

Tipo de folha de propriedades	Significado
DIGCDP_FLAG_ADVANCED	Folhas de propriedades avançadas.
DIGCDP_FLAG_BASIC	Folhas de propriedades básicas. Com suporte apenas no Microsoft Windows 95 e Windows 98. Não use no Windows 2000 e versões posteriores do Windows.
DIGCDP_FLAG_REMOTE_ADVANCED	Folhas de propriedades avançadas em um computador remoto.

Valor de retorno

A função retornará TRUE se bem-sucedida. Caso contrário, a função retornará FALSE. Chame GetLastError para obter o código de erro.

Observações

Uma estrutura PROPERTYSHEETHEADER contém dois membros associados a uma matriz fornecida pelo chamador que a função usa para retornar os identificadores de folhas de propriedades. O phpages membro é um ponteiro para uma matriz fornecida pelo chamador de identificadores de folha de propriedades e o valor de entrada do membro nPages especifica o número de identificadores que já estão contidos na matriz de identificadores. A função adiciona identificadores de folha de propriedades à matriz de identificadores começando com o elemento de matriz cujo índice de matriz é o valor de entrada de nPages. A função adiciona identificadores à matriz em ordem consecutiva até que a matriz esteja cheia ou os identificadores de todas as páginas da folha de propriedades solicitadas tenham sido adicionados à matriz. O número máximo de identificadores de folha de propriedades que a função pode retornar é igual a (PropertySheetHeaderPageListSize – (valor de entrada de nPages)).

Se a matriz de identificadores for grande o suficiente para manter as alças de todas as páginas da folha de propriedades solicitadas, a função:

Adiciona os identificadores à matriz de identificadores.
Define nPages para o número total de identificadores na matriz.
Define RequiredSize para o número de identificadores retornados.
Retorna VERDADEIRO.

Se a matriz de identificadores não for grande o suficiente para manter as alças de todas as páginas da folha de propriedades especificadas, a função:

Adiciona o máximo de identificadores que a matriz pode conter.
Define nPages para PropertySheetHeaderPageListSize.
Define RequiredSize para o número total de páginas da folha de propriedades solicitadas. O número de identificadores que não são retornados pela função é igual a (RequiredSize - PropertySheetHeaderPageListSize – (valor de entrada de nPages)).
Define o código de erro como ERROR_INSUFFICIENT_BUFFER.
Retorna FALSE .

Nota

O cabeçalho setupapi.h define SetupDiGetClassDevPropertySheets como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Disponível no Microsoft Windows 2000 e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	setupapi.h (inclua Setupapi.h)
biblioteca	Setupapi.lib

Consulte também

SP_DEVINFO_DATA

Compartilhar via