トレーニング
rtmv2.h ヘッダー
このヘッダーは、ルーティングとリモート アクセス サービスによって使用されます。 詳細については、次を参照してください。
rtmv2.h には、次のプログラミング インターフェイスが含まれています。
RTM_IPV4_GET_ADDR_AND_LEN RTM_IPV4_GET_ADDR_AND_LEN マクロは、汎用のネット アドレスと長さを IPv4 RTM_NET_ADDRESS構造体と長さに変換します。 |
RTM_IPV4_GET_ADDR_AND_MASK RTM_IPV4_GET_ADDR_AND_MASK マクロは、汎用のRTM_NET_ADDRESS構造体に変換し、長さを IPv4 アドレスとマスクに変換します。 |
RTM_IPV4_LEN_FROM_MASK RTM_IPV4_LEN_FROM_MASK マクロは、IPv4 マスクを汎用ルート長に変換します。 |
RTM_IPV4_MAKE_NET_ADDRESS RTM_IPV4_MAKE_NET_ADDRESS マクロは、IPv4 アドレスと長さを汎用RTM_NET_ADDRESS構造体に変換します。 |
RTM_IPV4_MASK_FROM_LEN RTM_IPV4_MASK_FROM_LEN マクロは、汎用ルート長を IPv4 マスクに変換します。 |
RTM_IPV4_SET_ADDR_AND_LEN RTM_IPV4_SET_ADDR_AND_LEN マクロは、IPv4 アドレスと長さを汎用RTM_NET_ADDRESS構造体に変換します。 |
RTM_IPV4_SET_ADDR_AND_MASK RTM_IPV4_SET_ADDR_AND_MASK マクロは、IPv4 アドレスとマスクを汎用RTM_NET_ADDRESS構造体に変換します。 |
RTM_SIZE_OF_DEST_INFO RTM_SIZE_OF_DEST_INFO マクロは、変換先の情報構造体 (RTM_DEST_INFO) のサイズを返します。 |
RTM_SIZE_OF_ROUTE_INFO RTM_SIZE_OF_ROUTE_INFO マクロは、ルート情報構造のサイズ (RTM_ROUTE_INFO) を返します。 |
RtmAddNextHop RtmAddNextHop 関数は、新しい次ホップ エントリを追加するか、既存の次ホップ エントリをクライアントの次ホップ リストに更新します。 |
RtmAddRouteToDest RtmAddRouteToDest 関数は、ルーティング テーブルに新しいルートを追加するか、ルーティング テーブル内の既存のルートを更新します。 最適なルートが変更されると、変更通知が生成されます。 |
RtmBlockMethods RtmBlockMethods 関数は、指定された宛先、ルート、または次ホップ、またはすべての宛先、ルート、および次ホップに対するメソッドの実行をブロックまたはブロック解除します。 |
RtmCreateDestEnum RtmCreateDestEnum 関数は、ルーティング テーブル内の宛先の列挙を開始します。 クライアントは、1 つ以上のビューまたはすべてのビューの宛先を列挙できます。 |
RtmCreateNextHopEnum RtmCreateNextHopEnum は、次ホップ リスト内の次ホップを列挙します。 |
RtmCreateRouteEnum RtmCreateRouteEnum 関数は、ルーティング テーブル内の特定の宛先または宛先の範囲のルートの列挙を作成します。 クライアントは、1 つ以上のビューまたはすべてのビューのルートを列挙できます。 |
RtmCreateRouteList RtmCreateRouteList 関数は、呼び出し元が所有するルートのコピーを保持できるリストを作成します。 |
RtmCreateRouteListEnum RtmCreateRouteListEnum 関数は、指定したルート リストにルートの列挙を作成します。 |
RtmDeleteEnumHandle RtmDeleteEnumHandle 関数は、指定された列挙ハンドルを削除し、列挙に割り当てられているすべてのリソースを解放します。 |
RtmDeleteNextHop RtmDeleteNextHop 関数は、次ホップ リストから次ホップを削除します。 |
RtmDeleteRouteList RtmDeleteRouteList 関数は、クライアント固有のルート リストからすべてのルートを削除し、リストに割り当てられているリソースを解放します。 |
RtmDeleteRouteToDest RtmDeleteRouteToDest 関数は、ルーティング テーブルからルートを削除し、最適なルートが変更された場合に対応する宛先の最適なルート情報を更新します。 最適なルートが変更されると、変更通知が生成されます。 |
RtmDeregisterEntity RtmDeregisterEntity 関数は、ルーティング テーブル マネージャー インスタンスとアドレス ファミリからクライアントの登録を解除します。 |
RtmDeregisterFromChangeNotification RtmDeregisterFromChangeNotification 関数は、変更通知からクライアントの登録を解除し、通知に割り当てられているすべてのリソースを解放します。 |
RtmFindNextHop RtmFindNextHop 関数は、クライアントの次ホップ リスト内の特定の次ホップを検索します。 |
RtmGetChangedDests RtmGetChangedDests 関数は、変更された情報を含む一連の変換先を返します。 |
RtmGetChangeStatus RtmGetChangeStatus 関数は、RtmGetChangedDests で取得されていない保留中の変更があるかどうかを確認します。 |
RtmGetDestInfo RtmGetDestInfo 関数は、変換先に関する情報を返します。 |
RtmGetEntityInfo RtmGetEntityInfo 関数は、以前に登録されたクライアントに関する情報を返します。 |
RtmGetEntityMethods RtmGetEntityMethods 関数は、指定されたクライアントに対してクエリを実行して、別のクライアントが呼び出すために使用できるメソッドを決定します。 |
RtmGetEnumDests RtmGetEnumDests 関数は、指定された列挙体の次の変換先セットを取得します。 |
RtmGetEnumNextHops RtmGetEnumNextHops 関数は、指定された列挙体の次のホップのセットを取得します。 |
RtmGetEnumRoutes RtmGetEnumRoutes 関数は、指定された列挙体内の次のルート セットを取得します。 |
RtmGetExactMatchDestination RtmGetExactMatchDestination 関数は、指定されたネットワーク アドレスとサブネット マスクと正確に一致する宛先をルーティング テーブルで検索します。 完全一致が見つかった場合は、その宛先の情報が返されます。 |
RtmGetExactMatchRoute RtmGetExactMatchRoute 関数は、指定されたルートと完全に一致するルートをルーティング テーブルで検索します。 |
RtmGetLessSpecificDestination RtmGetLessSpecificDestination 関数は、宛先プレフィックスが指定された次に最適な (最長) プレフィックスを持つ宛先をルーティング テーブルで検索します。 要求された宛先情報が返されます。 |
RtmGetListEnumRoutes RtmGetListEnumRoutes 関数は、指定されたルート リスト内の一連のルートを列挙します。 |
RtmGetMostSpecificDestination RtmGetMostSpecificDestination 関数は、指定されたネットワーク アドレスとサブネット マスクと完全に一致する宛先をルーティング テーブルで検索します。完全一致が見つからない場合は、最適なプレフィックスが一致します。 |
RtmGetNextHopInfo RtmGetNextHopInfo 関数は、指定された次ホップに関する情報を返します。 |
RtmGetNextHopPointer RtmGetNextHopPointer 関数は、指定された次ホップへの直接ポインターを取得します。 ポインターを使用すると、次ホップ所有者はルーティング テーブル マネージャーのRTM_NEXTHOP_INFO構造に直接読み取りアクセスできます。 |
RtmGetOpaqueInformationPointer RtmGetOpaqueInformationPointer 関数は、このクライアント用に予約されている宛先の不透明な情報フィールドへのポインターを返します。 |
RtmGetRegisteredEntities RtmGetRegisteredEntities 関数は、ルーティング テーブル マネージャーと指定したアドレス ファミリの指定されたインスタンスに登録されているすべてのクライアントに関する情報を返します。 |
RtmGetRouteInfo RtmGetRouteInfo 関数は、指定されたルートの情報を返します。 |
RtmGetRoutePointer RtmGetRoutePointer 関数は、ルートの所有者が読み取りアクセスを許可するルートへの直接ポインターを取得します。 |
RtmHoldDestination RtmHoldDestination 関数は、一定の時間、保留状態になる宛先をマークします。 保留は、ビュー内の宛先の最後のルートが削除された場合にのみ発生します。 |
RtmIgnoreChangedDests RtmIgnoreChangedDests 関数は、宛先ごとに次の変更が既に発生している場合はスキップします。 |
RtmInsertInRouteList RtmInsertInRouteList 関数は、指定したルート セットをクライアントのルート リストに挿入します。 ルートが既に別のリストにある場合、ルートは古いリストから削除され、新しいリストに挿入されます。 |
RtmInvokeMethod RtmInvokeMethod 関数は、別のクライアントによってエクスポートされたメソッドを呼び出します。 |
RtmIsBestRoute RtmIsBestRoute 関数は、指定されたルートが宛先への最適なルートであるビューのセットを返します。 |
RtmIsMarkedForChangeNotification RtmIsMarkedForChangeNotification 関数は、ルーティング テーブル マネージャーに対してクエリを実行し、以前に RtmMarkDestForChangeNotification の呼び出しによって宛先がマークされているかどうかを判断します。 |
RtmLockDestination RtmLockDestination 関数は、ルーティング テーブル内の宛先をロックまたはロック解除します。 この関数を使用して、不透明なポインターを変更しながら宛先を保護します。 |
RtmLockNextHop RtmLockNextHop 関数は、次ホップをロックまたはロック解除します。 この関数は、次ホップに変更を加える前に次ホップをロックするために、次ホップの所有者によって呼び出される必要があります。 次ホップへのポインターが返されます。 |
RtmLockRoute RtmLockRoute 関数は、ルーティング テーブル内のルートをロックまたはロック解除します。 これにより、クライアントがクライアントが所有する不透明なルート ポインターに必要な変更を加えながら、ルートが保護されます。 |
RtmMarkDestForChangeNotification RtmMarkDestForChangeNotification 関数は、クライアントの宛先をマークします。 |
RtmReferenceHandles RtmReferenceHandles 関数は、ルーティング マネージャーがそれらのオブジェクトへのアクセスに使用した 1 つ以上のハンドルが指すオブジェクトの参照数を増やします。 |
RtmRegisterEntity RtmRegisterEntity 関数は、特定のアドレス ファミリのルーティング テーブル マネージャーのインスタンスにクライアントを登録します。 |
RtmRegisterForChangeNotification RtmRegisterForChangeNotification 関数は、クライアントが指定した種類の変更に関する変更通知を受け取る必要があることをルーティング テーブル マネージャーに通知します。 |
RtmReleaseChangedDests RtmReleaseChangedDests 関数は、変更された宛先ハンドルを解放します。 |
RtmReleaseDestInfo RtmReleaseDestInfo 関数は、変換先の構造体を解放します。 |
RtmReleaseDests RtmReleaseDests 関数は、宛先ハンドルを解放します。 |
RtmReleaseEntities RtmReleaseEntities 関数は、RtmGetRegisteredEntities によって返されるクライアント ハンドルを解放します。 |
RtmReleaseEntityInfo RtmReleaseEntityInfo 関数は、クライアント構造を解放します。 |
RtmReleaseNextHopInfo RtmReleaseNextHopInfo 関数は、次ホップ構造を解放します。 |
RtmReleaseNextHops RtmReleaseNextHops 関数は、次ホップ ハンドルを解放します。 |
RtmReleaseRouteInfo RtmReleaseRouteInfo 関数は、ルート構造を解放します。 |
RtmReleaseRoutes RtmReleaseRoutes 関数は、ルート ハンドルを解放します。 |
RtmUpdateAndUnlockRoute RtmUpdateAndUnlockRoute 関数は、宛先のルートセット内のルートの位置を更新し、宛先に最適なルート情報を調整します。 |
_ENTITY_METHOD RTM_ENTITY_EXPORT_METHOD コールバックは、クライアントによってエクスポートされるすべてのメソッドのプロトタイプです。 |
_EVENT_CALLBACK RTM_EVENT_CALLBACKコールバックは、指定したイベントが発生したことをクライアントに通知するためにルーティング テーブル マネージャーによって使用されます。 |
RTM_DEST_INFO RTM_DEST_INFO構造体は、ルーティング テーブル マネージャーに登録されているクライアントと宛先情報を交換するために使用されます。 |
RTM_ENTITY_EXPORT_METHODS RTM_ENTITY_EXPORT_METHODS構造体には、クライアントによってエクスポートされた一連のメソッドが含まれています。 |
RTM_ENTITY_ID RTM_ENTITY_ID構造は、ルーティング テーブル マネージャーに対するクライアントを一意に識別するために使用されます。 プロトコル識別子とインスタンス識別子は、クライアントを一意に識別するために使用される値です。 |
RTM_ENTITY_INFO RTM_ENTITY_INFO構造は、クライアント情報をルーティング テーブル マネージャーと交換するために使用されます。 |
RTM_ENTITY_METHOD_INPUT RTM_ENTITY_METHOD_INPUT構造体は、メソッドを呼び出すときにクライアントに情報を渡すために使用されます。 |
RTM_ENTITY_METHOD_OUTPUT RTM_ENTITY_METHOD_OUTPUT構造体は、ルーティング テーブル マネージャーがメソッドを呼び出すときに、呼び出し元のクライアントに情報を渡すために使用されます。 |
RTM_NET_ADDRESS RTM_NET_ADDRESS構造は、アドレス ファミリのルーティング テーブル マネージャーにアドレス情報を通信するために使用されます。 アドレス ファミリは、8 バイト未満の連続したアドレス マスクでのみ使用する必要があります。 |
RTM_NEXTHOP_INFO RTM_NEXTHOP_INFO構造体は、ルーティング テーブル マネージャーとネクストホップ情報を交換するために使用されます。 |
RTM_NEXTHOP_LIST RTM_NEXTHOP_LIST構造体には、ルート内の等コスト パスを決定するために使用される次ホップの一覧が含まれています。 |
RTM_PREF_INFO RTM_PREF_INFO構造体には、任意の 2 つのルートを比較するときに使用される情報が含まれています。 Preference メンバーの値には、Metric メンバーの値よりも多くの重みが与えられます。 |
RTM_REGN_PROFILE RTM_REGN_PROFILE構造体には、登録プロセス中に返される情報が含まれています。 この情報は、後の関数呼び出し (RtmGetEnumRoutes の呼び出しによって返されるルートの最大数など) に使用されます。 |
RTM_ROUTE_INFO RTM_ROUTE_INFO構造は、ルーティング テーブル マネージャーとルート情報を交換するために使用されます。 読み取り専用情報は変更しないでください。 |
RTM_EVENT_TYPE RTM_EVENT_TYPE列挙は、ルーティング テーブル マネージャーがRTM_EVENT_CALLBACK コールバックの使用についてクライアントに通知できるイベントを列挙します。 |