Función SetupDiGetClassDescriptionW (setupapi.h)

La función SetupDiGetClassDescription recupera la descripción de clase asociada al GUID de clase de instalación especificado.

Sintaxis

WINSETUPAPI BOOL SetupDiGetClassDescriptionW(
  [in]            const GUID *ClassGuid,
  [out]           PWSTR      ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize
);

Parámetros

[in] ClassGuid

GUID de la clase de instalación cuya descripción se va a recuperar.

[out] ClassDescription

Puntero a un búfer de caracteres que recibe la descripción de la clase.

[in] ClassDescriptionSize

Tamaño, en caracteres, del búfer ClassDescription .

[out, optional] RequiredSize

Puntero a variable de tipo DWORD que recibe el tamaño, en caracteres, necesario para almacenar la descripción de clase (incluido un terminador NULL). RequiredSize siempre es menor que LINE_LEN. Este parámetro es opcional y puede ser NULL.

Valor devuelto

La función devuelve TRUE si se realiza correctamente. De lo contrario, devuelve FALSE y el error registrado se puede recuperar con una llamada a GetLastError.

Comentarios

Llame a SetupDiGetClassDescriptionEx para recuperar la descripción de una clase de instalación instalada en un equipo remoto.

Nota

El encabezado setupapi.h define SetupDiGetClassDescription 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 Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Microsoft Windows 2000 y versiones posteriores de Windows.
Plataforma de destino Escritorio
Encabezado setupapi.h (incluya Setupapi.h)
Library Setupapi.lib
Conjunto de API ext-ms-win-setupapi-classinstallers-l1-1-2 (introducido en Windows 10, versión 10.0.14393)

Consulte también

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass