MprAdminInterfaceEnum 関数 (mprapi.h)
MprAdminInterfaceEnum 関数は、指定されたサーバー上のすべてのインターフェイスを列挙します。
構文
DWORD MprAdminInterfaceEnum(
[in] MPR_SERVER_HANDLE hMprServer,
[in] DWORD dwLevel,
[out] LPBYTE *lplpbBuffer,
[in] DWORD dwPrefMaxLen,
[out] LPDWORD lpdwEntriesRead,
[out] LPDWORD lpdwTotalEntries,
[in] LPDWORD lpdwResumeHandle
);
パラメーター
[in] hMprServer
この呼び出しを実行するルーターを処理します。 MprAdminServerConnect を呼び出して、このハンドルを取得します。
[in] dwLevel
lplpbBuffer パラメーターで情報が返される形式を表す DWORD 値。 ゼロを指定してください。
[out] lplpbBuffer
正常に完了すると、 MPR_INTERFACE_0 構造体の配列へのポインター。 MprAdminBufferFree を呼び出して、このメモリ バッファーを解放します。
[in] dwPrefMaxLen
返されるデータの推奨される最大長を指定します (8 ビット バイト単位)。 このパラメーターが -1 の場合、返されるバッファーは、使用可能なすべての情報を保持するのに十分な大きさです。
[out] lpdwEntriesRead
DWORD 変数へのポインター。 この変数は、列挙の現在位置から列挙されたインターフェイスの合計数を受け取ります。
[out] lpdwTotalEntries
DWORD 変数へのポインター。 この変数は、現在の再開位置から列挙された可能性のあるインターフェイスの合計数を受け取ります。
[in] lpdwResumeHandle
DWORD 変数へのポインター。 この変数は、列挙を続行するために使用できる再開ハンドルを指定します。 ハンドルは最初の呼び出しでは 0 で、後続の呼び出しでは変更されません。 戻りコードがERROR_MORE_DATA場合は、 ハンドルを使用して呼び出しを再実行して、より多くのデータを取得できます。 戻り値が返された場合、ハンドルが NULL の場合、列挙を続行できません。 その他の種類のエラーが返される場合、このハンドルは無効です。
このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数は再開ハンドルを返しません。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 意味 |
|---|---|
|
呼び出し元のアプリケーションに十分な特権がありません。 |
|
詳細については、以下を参照してください。列挙を続けることができます。 |
|
操作を完了するためのリソースが不足しています。 |
|
dwLevel の値が無効です。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mprapi.h |
| Library | Mprapi.lib |
| [DLL] | Mprapi.dll |