Función SetupDiGetClassDescriptionExW (setupapi.h)
La función SetupDiGetClassDescriptionEx recupera la descripción de una clase de instalación instalada en un equipo local o remoto.
Sintaxis
WINSETUPAPI BOOL SetupDiGetClassDescriptionExW(
[in] const GUID *ClassGuid,
[out] PWSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCWSTR MachineName,
PVOID Reserved
);
Parámetros
[in] ClassGuid
Puntero al 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 al que apunta el parámetro ClassDescription. La longitud máxima, en caracteres, de una descripción de clase terminada en NULL es LINE_LEN. Para obtener más información, consulte la siguiente sección Comentarios.
[out, optional] RequiredSize
Puntero a una variable con tipo DWORD que recibe el tamaño, en caracteres, necesario para almacenar la descripción de clase terminada en NULL solicitada. Este puntero es opcional y se puede NULL.
[in, optional] MachineName
Puntero a una cadena terminada en NULL que proporciona el nombre de un equipo remoto en el que reside la clase de instalación. Este puntero es opcional y se puede NULL. Si la clase está instalada en un equipo local, establezca el puntero en NULL.
Reserved
Reservado para uso del sistema. Un autor de llamada de esta función debe establecer este parámetro en NULL.
Valor devuelto
La función devuelve TRUE si se ejecuta correctamente. De lo contrario, devuelve false y el error registrado se puede recuperar con una llamada a GetLastError.
Observaciones
Si hay un nombre descriptivo en la clave del Registro para la clase , esta rutina devuelve el nombre descriptivo. De lo contrario, esta rutina devuelve el nombre de clase.
setupDiGetClassDescriptionEx no aplica una restricción sobre la longitud de la descripción de clase que puede devolver. Esta función devuelve el tamaño necesario para una descripción de clase terminada en NULL aunque sea mayor que LINE_LEN. Sin embargo, LINE_LEN es la longitud máxima de una descripción válida de clase terminada en NULL. Un autor de llamada nunca debe necesitar un búfer que sea mayor que LINE_LEN.
Nota
El encabezado setupapi.h define SetupDiGetClassDescriptionEx 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 |