Função MprAdminInterfaceGetHandle (mprapi.h)
A função MprAdminInterfaceGetHandle recupera um identificador para uma interface especificada.
Sintaxe
DWORD MprAdminInterfaceGetHandle(
[in] MPR_SERVER_HANDLE hMprServer,
[in] LPWSTR lpwsInterfaceName,
[out] HANDLE *phInterface,
[in] BOOL fIncludeClientInterfaces
);
Parâmetros
[in] hMprServer
Manipule para o roteador no qual executar essa chamada. Obtenha esse identificador chamando MprAdminServerConnect.
[in] lpwsInterfaceName
Ponteiro para uma cadeia de caracteres Unicode terminada em nulo que especifica o nome da interface a ser recuperada.
[out] phInterface
Ponteiro para uma variável HANDLE que recebe um identificador para a interface especificada por lpwsInterfaceName.
[in] fIncludeClientInterfaces
Especifica se a função retorna uma interface do cliente. Se esse parâmetro for FALSE, as interfaces do tipo ROUTER_IF_TYPE_CLIENT serão ignoradas na pesquisa da interface com o nome especificado por lpwsInterfaceName. Se esse parâmetro for TRUE e houver uma interface com o nome especificado, MprAdminInterfaceGetHandle retornará um identificador para uma interface do tipo ROUTER_IF_TYPE_CLIENT. Como é possível que haja várias interfaces do tipo ROUTER_IF_TYPE_CLIENT, o identificador retornado faz referência à primeira interface encontrada com o nome especificado por lpwsInterfaceName.
Valor retornado
Se a função for bem-sucedida, o valor retornado será NO_ERROR.
Se a função falhar, o valor retornado será um dos seguintes códigos de erro.
| Valor | Significado |
|---|---|
|
O aplicativo de chamada não tem privilégios suficientes. |
|
Nenhuma interface existe com o nome especificado por lpwsInterfaceName. |
|
O identificador passado para o servidor é NULL. |
|
lpwsInterfaceName é NULL. |
Requisitos
| Cliente mínimo com suporte | Nenhum compatível |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | mprapi.h |
| Biblioteca | Mprapi.lib |
| DLL | Mprapi.dll |