MprAdminInterfaceGetCredentials 函数 (mprapi.h)

  • 项目

使用 MprAdminInterfaceGetCredentials 函数检索域、用户名和密码，以便在指定的按需拨号接口上拨出。

语法

DWORD MprAdminInterfaceGetCredentials(
  [in]  LPWSTR lpwsServer,
  [in]  LPWSTR lpwsInterfaceName,
  [out] LPWSTR lpwsUserName,
  [out] LPWSTR lpwsPassword,
  [out] LPWSTR lpwsDomainName
);

parameters

[in] lpwsServer

指向 以 null 结尾的 Unicode 字符串的指针，该字符串指定要对其执行此调用的路由器的名称。

此参数是可选的。 如果调用应用程序为此参数指定 NULL ，则在本地计算机上执行调用。

[in] lpwsInterfaceName

指向 以 null 结尾的 Unicode 字符串的指针，该字符串指定请求拨号接口的名称。 使用 MprAdminInterfaceGetInfo 获取接口名称。

[out] lpwsUserName

指向接收用户名的 Unicode 字符串的指针。 此字符串应为 UNLEN+1 长。

此参数是可选的。 如果调用应用程序为此参数指定 NULL ，则该函数不会返回用户名。

[out] lpwsPassword

指向接收密码的 Unicode 字符串的指针。 此字符串应为 PWLEN+1 长。

此参数是可选的。 如果调用应用程序为此参数指定 NULL ，则该函数不会返回密码。

[out] lpwsDomainName

指向接收域名的 Unicode 字符串的指针。 此字符串应为 DNLEN+1 长。

此参数是可选的。 如果调用应用程序为此参数指定 NULL ，则该函数不会返回域名。

返回值

如果函数成功，则返回值NO_ERROR。

如果函数失败，则返回值为以下错误代码之一。

值 含义
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 指定的接口没有任何与之关联的请求拨号参数。
ERROR_INVALID_PARAMETER
 lpwsInterfaceName 参数为 NULL。
NO_ERROR
 lpwsUserName、lpwsPassword 和 lpwsDomainName 参数均为 NULL。
其他
 使用 FormatMessage 检索与返回的错误代码对应的系统错误消息。

注解

lpwsUserName、lpwsPassword 和 lpwsDomainName 参数是可选的。 如果调用应用程序为所有三个参数指定 NULL ， 则 MprAdminInterfaceGetCredentials 将返回NO_ERROR并且不返回域、用户名和密码。

常量 UNLEN、PWLEN 和 DNLEN 是用户名、密码和域名的最大长度。 这些常量在 lmcons.h 中定义。

请注意， MprAdminInterfaceGetCredentials 中的参数顺序不同于 MprAdminInterfaceSetCredentials。

要求

   
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

另请参阅

FormatMessage

MprAdminInterfaceSetCredentials

路由器管理功能

路由器管理参考