Función SetupDiGetClassDescriptionExA (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 SetupDiGetClassDescriptionExA(
  [in]            const GUID *ClassGuid,
  [out]           PSTR       ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize,
  [in, optional]  PCSTR      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, vea 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 puede ser 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 puede ser NULL. Si la clase está instalada en un equipo local, establezca el puntero en NULL.

Precaución

No se admite el uso de esta función para acceder a máquinas remotas a partir de Windows 8 y Windows Server 2012, ya que esta funcionalidad se ha quitado.

Reserved

Reservado para uso del sistema. Un llamador de esta función debe establecer este parámetro en 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

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 en 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 incluso si es 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 la llamada nunca debe necesitar un búfer 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en 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

Consulte también

SetupDiBuildClassInfoList

SetupDiBuildClassInfoListEx

SetupDiGetDeviceInfoListDetail

SetupDiGetINFClass