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