función CM_Get_Device_Interface_AliasA (cfgmgr32.h)

La función CM_Get_Device_Interface_Alias devuelve el alias de la instancia de interfaz de dispositivo especificada, si el alias existe.

Sintaxis

CMAPI CONFIGRET CM_Get_Device_Interface_AliasA(
  [in]      LPCSTR pszDeviceInterface,
  [in]      LPGUID AliasInterfaceGuid,
  [out]     LPSTR  pszAliasDeviceInterface,
  [in, out] PULONG pulLength,
  [in]      ULONG  ulFlags
);

Parámetros

[in] pszDeviceInterface

Puntero al nombre de la instancia de interfaz de dispositivo para la que se va a recuperar un alias. El autor de la llamada normalmente recibió esta cadena de una llamada a CM_Get_Device_Interface_List, o en una estructura de notificación PnP.

[in] AliasInterfaceGuid

Puntero a un GUID que especifica la clase de interfaz del alias que se va a recuperar.

[out] pszAliasDeviceInterface

Especifica un puntero a un búfer, que, tras devolverse correctamente, apunta a una cadena que contiene el nombre del alias. El autor de la llamada debe liberar esta cadena cuando ya no se necesite.

Se requiere un búfer. De lo contrario, se producirá un error en la llamada.

[in, out] pulLength

Proporciona el recuento de caracteres en pszAliasDeviceInterface y recibe el número de caracteres necesarios para contener la interfaz del dispositivo de alias.

En la entrada, este parámetro debe ser mayor que 0.

[in] ulFlags

Reservado. No utilizar.

Valor devuelto

Si la operación se realiza correctamente, la función devuelve CR_SUCCESS. De lo contrario, devuelve uno de los códigos de error con prefijo CR_ definidos en Cfgmgr32.h.

Código devuelto	Descripción
CR_NO_SUCH_DEVICE_INTERFACE	Posiblemente indica que no hay ningún alias de la clase de interfaz especificada.
CR_OUT_OF_MEMORY	no hay suficiente memoria para completar la operación.
CR_BUFFER_SMALL	El búfer pasado es demasiado pequeño.

Comentarios

Las interfaces de dispositivo se consideran alias si están expuestas por el mismo dispositivo subyacente y tienen cadenas de referencia de interfaz idénticas, pero son de clases de interfaz diferentes.

El parámetro pszDeviceInterface especifica una instancia de interfaz de dispositivo para un dispositivo determinado, que pertenece a una clase de interfaz determinada, con una cadena de referencia determinada. CM_Get_Device_Interface_Alias devuelve otra instancia de interfaz de dispositivo para el mismo dispositivo y cadena de referencia, pero de una clase de interfaz diferente, si existe.

Por ejemplo, el controlador de función para un volumen tolerante a errores podría registrar y establecer dos interfaces de dispositivo, una de las clases de interfaz de volumen tolerantes a errores y una de las clases de interfaz de volumen. Otro controlador podría llamar a CM_Get_Device_Interface_Alias con el vínculo simbólico de una de las interfaces y preguntar si existe la otra interfaz especificando su clase de interfaz.

Dos interfaces de dispositivo con cadenas de referencia NULL son alias si están expuestos por el mismo dispositivo subyacente y tienen GUID de clase de interfaz diferentes.

Requisitos

Requisito	Value
Cliente mínimo compatible	Disponible en Microsoft Windows 2000 y versiones posteriores de Windows.
Plataforma de destino	Escritorio
Encabezado	cfgmgr32.h (incluya Cfgmgr32.h)
Library	Cfgmgr32.lib