MgmGetFirstMfe 関数 (mgm.h)

  • [アーティクル]

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

バッファーで返されるデータは、最初にグループ、次にグループ内のソースによって順序付けられます。

構文

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

パラメーター

[in, out] pdwBufferSize

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

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

[in, out] pbBuffer

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

出力時に、 pbBuffer には 1 つ以上の MF が含まれます。 各 MFE は MIB_IPMCAST_MFE 構造です。

[in, out] pdwNumEntries

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

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

戻り値

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

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

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

注釈

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

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

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

要件

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

こちらもご覧ください

MIB_IPMCAST_MFE

MgmGetMfe

MgmGetNextMfe