Compartir a través de

Función SetupDiGetClassDevPropertySheetsW (setupapi.h)

  • Artículo

La función SetupDiGetClassDevPropertySheets recupera identificadores de las hojas de propiedades de un elemento de información del dispositivo o de la clase de configuración de dispositivo de un conjunto de información del dispositivo.

Sintaxis

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

Parámetros

[in] DeviceInfoSet

Identificador del conjunto de información del dispositivo para el que se devuelven identificadores de hoja de propiedades. Si deviceInfoData no especifica un elemento de información del dispositivo en el conjunto de información del dispositivo, el conjunto de información del dispositivo debe tener una clase de configuración de dispositivo asociada.

[in, optional] DeviceInfoData

Puntero a una estructura SP_DEVINFO_DATA que especifica un elemento de información del dispositivo en DeviceInfoSet.

Este parámetro es opcional y se puede NULL. Si se especifica este parámetro, SetupDiGetClassDevPropertySheets recupera los identificadores de hojas de propiedades asociados al dispositivo especificado. Si este parámetro es NULL, SetupDiGetClassDevPropertySheets recupera los identificadores de las hojas de propiedades asociadas a la clase de instalación de dispositivos especificada en DeviceInfoSet.

[in] PropertySheetHeader

Puntero a una estructura PROPERTYSHEETHEADER. Consulte la sección comentarios de para obtener información sobre la matriz proporcionada por el autor de la llamada de los identificadores de hoja de propiedades asociados a esta estructura.

Para obtener más documentación sobre esta estructura y hojas de propiedades en general, consulte Microsoft Windows SDK.

[in] PropertySheetHeaderPageListSize

Número máximo de identificadores que puede contener la matriz proporcionada por el autor de la llamada de los identificadores de hoja de propiedades.

[out, optional] RequiredSize

Puntero a una variable de tipo DWORD que recibe el número de hojas de propiedades asociadas al elemento de información del dispositivo especificado o a la clase de configuración del dispositivo del conjunto de información del dispositivo especificado. El puntero es opcional y puede ser NULL.

[in] PropertySheetType

Marca que indica uno de los siguientes tipos de hojas de propiedades.

Tipo de hoja de propiedades Significado
DIGCDP_FLAG_ADVANCED Hojas de propiedades avanzadas.
DIGCDP_FLAG_BASIC Hojas de propiedades básicas. Solo se admite en Microsoft Windows 95 y Windows 98. No use en Windows 2000 ni en versiones posteriores de Windows.
DIGCDP_FLAG_REMOTE_ADVANCED Hojas de propiedades avanzadas en un equipo remoto.

Valor devuelto

La función devuelve TRUE si se ejecuta correctamente. De lo contrario, la función devuelve FALSE. Llame a GetLastError para obtener el código de error.

Observaciones

Una estructura PROPERTYSHEETHEADER contiene dos miembros asociados a una matriz proporcionada por el autor de la llamada que la función usa para devolver los identificadores de las hojas de propiedades. El miembro phpages es un puntero a una matriz proporcionada por el autor de la llamada de identificadores de hoja de propiedades y el valor de entrada del miembro nPages especifica el número de identificadores que ya están incluidos en la matriz de identificadores. La función agrega identificadores de hoja de propiedades a la matriz handle a partir del elemento de matriz cuyo índice de matriz es el valor de entrada de nPages. La función agrega identificadores a la matriz en orden consecutivo hasta que la matriz está llena o los identificadores de todas las páginas de hoja de propiedades solicitadas se han agregado a la matriz. El número máximo de identificadores de hoja de propiedades que la función puede devolver es igual a (PropertySheetHeaderPageListSize - (valor de entrada de nPages)).

Si la matriz de identificadores es lo suficientemente grande como para contener los identificadores de todas las páginas de hoja de propiedades solicitadas, la función :

  • Agrega los identificadores a la matriz de identificadores.
  • Establece nPages en el número total de identificadores de la matriz.
  • Establece requiredSize al número de identificadores que devuelve.
  • Devuelve TRUE.
Si la matriz de identificadores no es lo suficientemente grande como para contener los identificadores de todas las páginas de hoja de propiedades especificadas, la función :
  • Agrega tantos identificadores como la matriz puede contener.
  • Establece nPages en PropertySheetHeaderPageListSize.
  • Establece RequiredSize en el número total de páginas de hojas de propiedades solicitadas. El número de identificadores que no devuelve la función es igual a (RequiredSize - PropertySheetHeaderPageListSize - (valor de entrada de nPages)).
  • Establece el código de error en ERROR_INSUFFICIENT_BUFFER.
  • Devuelve false.

Nota

El encabezado setupapi.h define SetupDiGetClassDevPropertySheets como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito Valor
cliente mínimo admitido Disponible en Microsoft Windows 2000 y versiones posteriores de Windows.
de la plataforma de destino de Escritorio
encabezado de setupapi.h (incluya Setupapi.h)
biblioteca de Setupapi.lib

Consulte también

SP_DEVINFO_DATA