MprAdminConnectionEnumEx 関数 (mprapi.h)

  • [アーティクル]

MprAdminConnectionEnumEx 関数は、指定された RRAS サーバーのアクティブな接続を列挙します。

構文

DWORD MprAdminConnectionEnumEx(
  [in]  RAS_SERVER_HANDLE     hRasServer,
  [in]  PMPRAPI_OBJECT_HEADER pObjectHeader,
  [in]  DWORD                 dwPreferedMaxLen,
  [out] LPDWORD               lpdwEntriesRead,
  [out] LPDWORD               lpdwTotalEntries,
  [out] PRAS_CONNECTION_EX    *ppRasConn,
  [in]  LPDWORD               lpdwResumeHandle
);

パラメーター

[in] hRasServer

接続が列挙される RAS サーバーへのハンドル。 MprAdminServerConnect を呼び出して、このハンドルを取得します。

[in] pObjectHeader

ppRasConn が受け取る構造体のバージョンを指定するMPRAPI_OBJECT_HEADER構造体へのポインター。

[in] dwPreferedMaxLen

返されるデータの推奨される最大長を 8 ビット バイトで指定する 値。 dwPrefMaxLen が -1 の場合、返されるバッファーは、使用可能なすべての情報を保持するのに十分な大きさです。

[out] lpdwEntriesRead

現在の再開位置から列挙された接続の合計数を受け取る DWORD へのポインター。

[out] lpdwTotalEntries

現在の再開位置から列挙された可能性のある接続の合計数を受け取る DWORD へのポインター。

[out] ppRasConn

出力時に、hRasServer内の RRAS サーバーのアクティブな接続情報を含むRAS_CONNECTION_EX構造体の配列へのポインター。 配列要素の数は、 lpdwEntriesRead が指す値によって決まります。

[in] lpdwResumeHandle

列挙を続行するために使用される再開ハンドルを指定する DWORD 変数へのポインター。 lpdwResumeHandle パラメーターは、最初の呼び出しでは NULL であり、後続の呼び出しでは変更されません。 戻りコードが ERROR_MORE_DATA場合は、このハンドルを使用して別の呼び出しを行って、より多くのデータを取得できます。 戻り時にハンドルが NULL の 場合、列挙は完了です。 このハンドルは、他の種類のエラーの戻り値には無効です。

戻り値

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

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

値 意味
ERROR_ACCESS_DENIED
 呼び出し元アプリケーションに十分な特権がありません。
ERROR_DDM_NOT_RUNNING
 Demand Dial Manager (DDM) が実行されていません。
ERROR_MORE_DATA
 この呼び出しで、すべてのデータが返されたわけではありません。 追加のデータを取得するには、再開ハンドルを使用して関数をもう一度呼び出します。
ERROR_PROC_NOT_FOUND
 指定されたプロシージャが見つかりませんでした。
その他
 MprError.h、RasError.h、または WinError.h からのエラー。

注釈

呼び出し元は、関数 MprAdminBufferFree を呼び出すことによって、ppRasConn が指すメモリを解放する必要があります。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー mprapi.h
Library Mprapi.lib
[DLL] Mprapi.dll

こちらもご覧ください

MprAdminBufferFree

MprAdminConnectionEnum

MprAdminServerConnect

RAS 管理関数

リモート アクセス サービス管理リファレンス