Função CM_Get_Device_Interface_AliasW (cfgmgr32.h)

  • Artigo

A função CM_Get_Device_Interface_Alias retornará o alias da instância de interface do dispositivo especificada, se o alias existir.

Sintaxe

CMAPI CONFIGRET CM_Get_Device_Interface_AliasW(
  [in]      LPCWSTR pszDeviceInterface,
  [in]      LPGUID  AliasInterfaceGuid,
  [out]     LPWSTR  pszAliasDeviceInterface,
  [in, out] PULONG  pulLength,
  [in]      ULONG   ulFlags
);

Parâmetros

[in] pszDeviceInterface

Ponteiro para o nome da instância da interface do dispositivo para a qual recuperar um alias. O chamador normalmente recebeu essa cadeia de caracteres de uma chamada para CM_Get_Device_Interface_List ou em uma estrutura de notificação PnP.

[in] AliasInterfaceGuid

Ponteiro para um GUID que especifica a classe de interface do alias a ser recuperado.

[out] pszAliasDeviceInterface

Especifica um ponteiro para um buffer, que, após o retorno bem-sucedido, aponta para uma cadeia de caracteres que contém o nome do alias. O chamador deve liberar essa cadeia de caracteres quando ela não for mais necessária.

Um buffer é necessário. Caso contrário, a chamada falhará.

[in, out] pulLength

Fornece a contagem de caracteres em pszAliasDeviceInterface e recebe o número de caracteres necessários para manter a interface do dispositivo de alias.

Na entrada, esse parâmetro deve ser maior que 0.

[in] ulFlags

Reservado. Não use.

Retornar valor

Se a operação for bem-sucedida, a função retornará CR_SUCCESS. Caso contrário, ele retornará um dos códigos de erro prefixados por CR_ definidos em Cfgmgr32.h.

Código de retorno Descrição
CR_NO_SUCH_DEVICE_INTERFACE
 Possivelmente indica que não há nenhum alias da classe de interface especificada.
CR_OUT_OF_MEMORY
 Não há memória suficiente para concluir a operação.
CR_BUFFER_SMALL
 O buffer passado é muito pequeno.

Comentários

As interfaces de dispositivo serão consideradas aliases se forem expostas pelo mesmo dispositivo subjacente e tiverem cadeias de caracteres de referência de interface idênticas, mas forem de classes de interface diferentes.

O parâmetro pszDeviceInterface especifica uma instância de interface do dispositivo para um dispositivo específico, pertencente a uma classe de interface específica, com uma cadeia de caracteres de referência específica. CM_Get_Device_Interface_Alias retorna outra instância de interface do dispositivo para o mesmo dispositivo e cadeia de caracteres de referência, mas de uma classe de interface diferente, se existir.

Por exemplo, o driver de função para um volume tolerante a falhas pode registrar e definir duas interfaces de dispositivo, uma da classe de interface de volume tolerante a falhas e uma da classe de interface de volume. Outro driver poderia chamar CM_Get_Device_Interface_Alias com o link simbólico para uma das interfaces e perguntar se a outra interface existe especificando sua classe de interface.

Duas interfaces de dispositivo com cadeias de caracteres de referência NULL serão aliases se forem expostas pelo mesmo dispositivo subjacente e tiverem GUIDs de classe de interface diferentes.

Requisitos

Requisito Valor
Cliente mínimo com suporte Disponível no Microsoft Windows 2000 e versões posteriores do Windows.
Plataforma de Destino Área de Trabalho
Cabeçalho cfgmgr32.h (inclua Cfgmgr32.h)
Biblioteca Cfgmgr32.lib