RtmGetChangedDests 関数 (rtmv2.h)

[アーティクル]
03/05/2024

RtmGetChangedDests 関数は、変更された情報を含む一連の変換先を返します。

構文

DWORD RtmGetChangedDests(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_NOTIFY_HANDLE NotifyHandle,
  [in, out] PUINT             NumDests,
  [out]     PRTM_DEST_INFO    ChangedDests
);

パラメーター

[in] RtmRegHandle

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

[in] NotifyHandle

RtmRegisterForChangeNotification の以前の呼び出しから取得した変更通知を処理します。

[in, out] NumDests

入力時、NumDests は、ChangedDests で受信できる宛先の最大数を指定する UINT 値へのポインターです。

出力時に、 NumDests はChangedDests によって受信された宛先の実際の数を受け取ります。

[out] ChangedDests

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

出力時に、 ChangedDests に変更された宛先情報が入力されます。

戻り値

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

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

値	意味
ERROR_INVALID_PARAMETER	パラメーターに正しくない情報が含まれています。
ERROR_NO_MORE_ITEMS	取得する変更先はこれ以上ありません。

注釈

クライアントには、 RTM_EVENT_CALLBACKによって変更が通知されます。 RTM_EVENT_CALLBACKはクライアントへの通知にのみ使用され、変更は配信されません。変更通知を受信した後、クライアントは RtmGetChangedDests を繰り返し呼び出してすべての変更を取得する必要があります。

通知以降に同じ宛先に対する変更が 2 つ以上発生した場合は、最新の変更のみが返されます。

クライアントで ChangedDests のハンドルが不要になった場合、クライアントは RtmReleaseChangedDests を使用してハンドルを解放する必要があります。

この関数を使用するサンプルコードについては、「イベント通知コールバックを使用する」を参照してください。

要件

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