Função SetupDiGetClassInstallParamsA (setupapi.h)

A função SetupDiGetClassInstallParams recupera parâmetros de instalação de classe para um conjunto de informações do dispositivo ou um elemento de informações de dispositivo específico.

Sintaxe

WINSETUPAPI BOOL SetupDiGetClassInstallParamsA(
  [in]            HDEVINFO                DeviceInfoSet,
  [in, optional]  PSP_DEVINFO_DATA        DeviceInfoData,
  [out, optional] PSP_CLASSINSTALL_HEADER ClassInstallParams,
  [in]            DWORD                   ClassInstallParamsSize,
  [out, optional] PDWORD                  RequiredSize
);

Parâmetros

[in] DeviceInfoSet

Um identificador para um conjunto de informações do dispositivo que contém os parâmetros de instalação de classe a serem recuperados.

[in, optional] DeviceInfoData

Um ponteiro para uma estrutura SP_DEVINFO_DATA que especificou um elemento de informações do dispositivo em DeviceInfoSet. Esse parâmetro é opcional e pode ser NULL. Se esse parâmetro for especificado, SetupDiGetClassInstallParams recuperará os parâmetros de instalação de classe para o dispositivo especificado. Se esse parâmetro for NULL, SetupDiGetClassInstallParams recuperará os parâmetros de instalação de classe para a lista de driver de classe global associada a DeviceInfoSet.

[out, optional] ClassInstallParams

Um ponteiro para um buffer que contém uma estrutura SP_CLASSINSTALL_HEADER . Essa estrutura deve ter seu membro cbSize definido como sizeof(SP_CLASSINSTALL_HEADER) na entrada ou o buffer é considerado inválido. Na saída, o membro InstallFunction é preenchido com o código da função de instalação do dispositivo para os parâmetros de instalação da classe que estão sendo recuperados. Se o buffer for grande o suficiente, ele também receberá a estrutura de parâmetros de instalação de classe específica para o código de função. Se ClassInstallParams não for especificado, ClassInstallParamsSize deverá ser 0.

[in] ClassInstallParamsSize

O tamanho, em bytes, do buffer ClassInstallParams . Se o buffer for fornecido, ele deverá ser pelo menos tão grande quanto sizeof(SP_CLASSINSTALL_HEADER). Se o buffer não for fornecido, ClassInstallParamsSize deverá ser 0.

[out, optional] RequiredSize

Um ponteiro para uma variável do tipo DWORD que recebe o número de bytes necessários para armazenar os parâmetros de instalação da classe. Esse parâmetro é opcional e pode ser NULL.

Retornar valor

A função retornará TRUE se for bem-sucedida. Caso contrário, ele retornará FALSE e o erro registrado poderá ser recuperado com uma chamada para GetLastError.

Comentários

Os parâmetros de instalação de classe são específicos para um código de função de instalação de dispositivo específico que é armazenado no campo ClassInstallHeader localizado no início do buffer ClassInstallParams .

Observação

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Disponível no Microsoft Windows 2000 e versões posteriores do Windows.
Plataforma de Destino	Área de Trabalho
Cabeçalho	setupapi.h (inclua Setupapi.h)
Biblioteca	Setupapi.lib

Confira também

SetupDiSetClassInstallParams