次の方法で共有

RtmGetEnumDests 関数 (rtmv2.h)

  • [アーティクル]

RtmGetEnumDests 関数は、指定された列挙体の次の宛先セットを取得します。

構文

DWORD RtmGetEnumDests(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_ENUM_HANDLE   EnumHandle,
  [in, out] PUINT             NumDests,
  [out]     PRTM_DEST_INFO    DestInfos
);

パラメーター

[in] RtmRegHandle

RtmRegisterEntity の以前の呼び出しから取得したクライアントを処理します。

[in] EnumHandle

変換先の列挙を処理します。

[in, out] NumDests

入力時、NumDests は、DestInfos で受信できる宛先の最大数を指定する UINT 値へのポインターです。 出力時に、 NumDests はDestInfos によって受信された宛先の実際の数を受け取ります。

[out] DestInfos

入力時、 DestInfos は RTM_DEST_INFO 構造体へのポインターです。

出力時に、 DestInfos は 宛先にハンドルの配列を受け取ります。

戻り値

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

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

値 説明
ERROR_INVALID_PARAMETER
 NumRoutes が指す値が、クライアントが 1 回の呼び出しで取得できるルートの最大数を超えています。 クライアントが 1 回の呼び出しで取得できる宛先の最大数をRTM_REGN_PROFILE確認します。
ERROR_NO_MORE_ITEMS
 列挙する宛先はこれ以上ありません。
 
 

解説

DestInfos が指す構造体は、可変サイズの構造体です。 クライアントが TargetViews で複数のビューを指定すると、 ビューごとに DestInfos のサイズが大きくなります。 RTM_SIZE_OF_DEST_INFO マクロを使用して、この関数を呼び出す前に割り当てる DestInfos 構造体の大きさを確認します。 RTM_SIZE_OF_DEST_INFOするパラメーターとして TargetViews に指定された値を使用します。

宛先が不要になったら、 RtmReleaseDests を呼び出して解放します。

この関数を使用するサンプル コードについては、「 すべての宛先を列挙する」を参照してください。

要件

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

関連項目

RTM_DEST_INFO

RtmCreateDestEnum

RtmDeleteEnumHandle

RtmReleaseDests