Função WlanSetProfileCustomUserData (wlanapi.h)

Artigo
08/28/2023

A função WlanSetProfileCustomUserData define os dados de usuário personalizados associados a um perfil.

Sintaxe

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       PVOID       pReserved
);

Parâmetros

[in] hClientHandle

O identificador de sessão do cliente, obtido por uma chamada anterior para a função WlanOpenHandle .

[in] pInterfaceGuid

O GUID da interface.

[in] strProfileName

O nome do perfil associado aos dados de usuário personalizados. Os nomes de perfil diferenciam maiúsculas de minúsculas. Essa cadeia de caracteres deve ser terminada em NULL.

[in] dwDataSize

O tamanho de pData, em bytes.

[in] pData

Um ponteiro para os dados do usuário a serem definidos.

pReserved

Reservado para uso futuro. Deve ser definido como NULL.

Retornar valor

Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado poderá ser um dos seguintes códigos de retorno.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	Uma das seguintes condições ocorreu: hClientHandle é NULL ou inválido. pInterfaceGuid é NULL. strProfileName é NULL. pReserved não é NULL. dwDataSize não é 0 e pData é NULL.
ERROR_INVALID_HANDLE	O identificador hClientHandle não foi encontrado na tabela de identificador.
ERROR_NOT_SUPPORTED	Essa função foi chamada de uma plataforma sem suporte. Esse valor será retornado se essa função for chamada de um Windows XP com SP3 ou API lan sem fio para Windows XP com cliente SP2.
RPC_STATUS	Vários códigos de erro.

Comentários

Para cada perfil WLAN sem fio usado pelo serviço de Configuração Automática de Wi-Fi Nativo, o Windows mantém o conceito de dados de usuário personalizados. Esses dados de usuário personalizados são inicialmente inexistentes, mas podem ser definidos chamando a função WlanSetProfileCustomUserData . Os dados personalizados do usuário são redefinidos para vazios sempre que o perfil é modificado chamando a função WlanSetProfile .

Depois que dados de usuário personalizados forem definidos, esses dados poderão ser acessados usando a função WlanGetProfileCustomUserData .

Todas as funções lan sem fio exigem um GUID de interface para a interface sem fio ao executar operações de perfil. Quando uma interface sem fio é removida, seu estado é desmarcado do WLANSVC (Wireless LAN Service) e nenhuma operação de perfil é possível.

A função WlanSetProfileCustomUserData poderá falhar com ERROR_INVALID_PARAMETER se a interface sem fio especificada no parâmetro pInterfaceGuid tiver sido removida do sistema (um adaptador sem fio USB que foi removido, por exemplo).

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	wlanapi.h (inclua Wlanapi.h)
Biblioteca	Wlanapi.lib
DLL	Wlanapi.dll