MprAdminInterfaceGetCredentials 関数 (mprapi.h)

MprAdminInterfaceGetCredentials 関数を使用して、指定したデマンド ダイヤル インターフェイスでダイヤルアウトするためのドメイン、ユーザー名、パスワードを取得します。

構文

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

パラメーター

[in] lpwsServer

この呼び出しを実行するルーターの名前を指定する null で終わる Unicode 文字列へのポインター。

このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、呼び出しはローカル コンピューターで実行されます。

[in] lpwsInterfaceName

デマンド ダイヤル インターフェイスの名前を指定する null で終わる Unicode 文字列へのポインター。 MprAdminInterfaceGetInfo を使用してインターフェイス名を取得します。

[out] lpwsUserName

ユーザーの名前を受け取る Unicode 文字列へのポインター。 この文字列は UNLEN+1 long である必要があります。

このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数はユーザー名を返しません。

[out] lpwsPassword

パスワードを受け取る Unicode 文字列へのポインター。 この文字列は PWLEN+1 long にする必要があります。

このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数はパスワードを返しません。

[out] lpwsDomainName

ドメイン名を受け取る Unicode 文字列へのポインター。 この文字列は DNLEN+1 long である必要があります。

このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、この関数はドメイン名を返しません。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

解説

lpwsUserName、lpwsPassword、lpwsDomainName の各パラメーターは省略可能です。 呼び出し元のアプリケーションで 3 つのパラメーターすべてに NULL が 指定されている場合、 MprAdminInterfaceGetCredentials はNO_ERRORを返し、ドメイン、ユーザー名、パスワードは返されません。

定数 UNLEN、PWLEN、DNLEN は、ユーザー名、パスワード、およびドメイン名の最大長です。 これらの定数は lmcons.h で定義されます。

MprAdminInterfaceGetCredentials のパラメーターの順序は、MprAdminInterfaceSetCredentials とは異なる点に注意してください。

要件

関連項目

FormatMessage

MprAdminInterfaceSetCredentials

ルーター管理機能

ルーター管理リファレンス