MgmGetFirstMfeStats 関数 (mgm.h)

  • [アーティクル]

MgmGetFirstMfeStats 関数は、MFE リストの先頭から MFE 統計を取得します。 この関数は、0 個、1 つ以上の MFE 統計セットを取得できます。 返されるセットの数は、エントリのサイズと、関数が呼び出されたときにクライアントによって提供されるバッファーのサイズによって異なります。

バッファーで返されるデータは、最初にグループ、次にグループ内のソースによって順序付けられます。 返される統計には、受信したパケット、受信したバイト数、各発信インターフェイスで転送されたパケットが含まれます。

構文

DWORD MgmGetFirstMfeStats(
  [in, out] PDWORD pdwBufferSize,
  [in, out] PBYTE  pbBuffer,
  [in, out] PDWORD pdwNumEntries,
            DWORD  dwFlags
);

パラメーター

[in, out] pdwBufferSize

入力時、pdwBufferSize は pbBuffer のサイズ (バイト単位) を含む DWORD サイズのメモリ位置へのポインターです。

出力時に戻り値がERROR_INSUFFICIENT_BUFFER場合、 pdwBufferSize は最小サイズ pbBuffer を受け取り、MFE 統計のセットを保持する必要があります。それ以外の場合、 pdwBufferSize の値は変更されません。

[in, out] pbBuffer

入力時に、クライアントはバッファーへのポインターを指定する必要があります。

出力時に、 pbBuffer には 1 つ以上の MFE 統計セットが含まれます。 MFE 統計の各セットは 、MIB_IPMCAST_MFE_STATS 構造です。

[in, out] pdwNumEntries

入力時に、クライアントは DWORD サイズのメモリ位置へのポインターを指定する必要があります。

出力時に、 pdwNumEntries は pbBuffer に含まれる MFE 統計のセットの数を受け取ります。

dwFlags

返されるデータ構造を決定します。

値 意味
MGM_MFE_STATS_0
 MIB_IPMCAST_MFE_STATSに対応する統計を含めます。
MGM_MFE_STATS_1
 MIB_IPMCAST_MFE_STATS_EXに対応する統計を含めます。

戻り値

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

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

値 意味
ERROR_CAN_NOT_COMPLETE
 この関数の呼び出しを完了できませんでした。
ERROR_INSUFFICIENT_BUFFER
 指定されたバッファーは、1 セットの MFE 統計に対しても小さすぎます。 クライアントは、1 つの統計セットを取得するために必要な最小バッファー サイズに対して pdwBufferSize の値をチェックする必要があります。
ERROR_MORE_DATA
 その他の MFE 統計を使用できます。
ERROR_NO_MORE_ITEMS
 MFE 統計はこれ以上使用できません。 0 個以上の MFE 統計セットが返されました。pdwNumEntries の値をチェックして、返された統計セットの数を確認します。

注釈

この関数は、MFE 統計の順次検索を開始するために使用されます。 MgmGetNextMfeStats を使用して取得プロセスを続行します。

一般に、MFE 統計を取得するには、まず MgmGetFirstMfeStats を呼び出します。 次に、返す MFE がなくなったら、 MgmGetNextMfeStats を 1 回以上呼び出します。 MgmGetNextMfeStats の各呼び出しは、MgmGetNextMfeStats の前回の呼び出しによって返された最後の MFE (または MgmGetFirstMfeStats の最初の呼び出し) の後に開始する必要があります。これを行うには、クライアントは前の呼び出しによって返されたバッファー内の最後のソースとグループを指定します。

MFE 統計は、dwFlags パラメーターによって決定されるMIB_IPMCAST_MFE_STATSまたはMIB_IPMCAST_MFE_STATS_EX構造体のいずれかで返されます。

メモpbBuffer によって指されるバッファーの最小サイズは固定されていません。MFE 統計のセットごとに異なります。 sizeof マクロを使用して、バッファーに返される統計の各セットのサイズを決定します。
 

要件

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

こちらもご覧ください

MIB_IPMCAST_MFE_STATS

MIB_IPMCAST_MFE_STATS_EX

MgmGetMfeStats

MgmGetNextMfeStats