RtmGetOpaqueInformationPointer 関数 (rtmv2.h)

  • [アーティクル]

RtmGetOpaqueInformationPointer 関数は、このクライアント用に予約されている宛先の不透明な情報フィールドへのポインターを返します。 ポインターを使用すると、クライアントは宛先を使用してクライアント固有の情報をルーティング テーブルに格納できます。

構文

DWORD RtmGetOpaqueInformationPointer(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_DEST_HANDLE   DestHandle,
  [out] PVOID             *OpaqueInfoPointer
);

パラメーター

[in] RtmRegHandle

RtmRegisterEntity の以前の呼び出しから取得したクライアントへのハンドル。

[in] DestHandle

宛先へのハンドル。

[out] OpaqueInfoPointer

入力では、 OpaqueInfoPointer は NULL へのポインターです。

出力時に、 OpaqueInfoPointer は 不透明な情報ポインターへのポインターを受け取ります。 登録中にクライアントが不透明なポインターを予約していない場合、このパラメーターは変更されません。

戻り値

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

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

値 説明
ERROR_INVALID_HANDLE
 ハンドルが正しくありません。
ERROR_NOT_FOUND
 不透明なポインターはクライアントによって予約されませんでした。
 
 

解説

この関数を使用するサンプル コードについては、「 宛先で不透明なポインターにアクセスする」を参照してください。

要件

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

関連項目

RtmLockDestination