PSTART_PROTOCOL コールバック関数 (routprot.h)
StartProtocol 関数は、ルーティング プロトコルの機能を初期化します。 ルーター マネージャーは、この関数を使用して、ルーティング プロトコルのグローバル構成パラメーターと API エントリ ポイントのセットを渡します。 プロトコルでは、これらのエントリ ポイントを使用してルーター マネージャーを呼び出します。
構文
PSTART_PROTOCOL PstartProtocol;
DWORD PstartProtocol(
[in] HANDLE NotificationEvent,
[in] PSUPPORT_FUNCTIONS SupportFunctions,
[in] LPVOID GlobalInfo,
[in] ULONG StructureVersion,
[in] ULONG StructureSize,
[in] ULONG StructureCount
)
{...}
パラメーター
[in] NotificationEvent
イベント オブジェクトを処理します。 ルーティング プロトコルは、ルーター マネージャーがプロトコルによって管理されているキューから非同期メッセージを取得する必要がある場合に、このイベントを通知します。
[in] SupportFunctions
SUPPORT_FUNCTIONS構造体へのポインター。 この構造体のフィールドは、ルーター マネージャーの関数へのポインターです。 これらの関数を使用すると、プロトコルはルーティング プロトコルにまたがる情報にアクセスできます。
[in] GlobalInfo
インターフェイス固有の構成情報ではなく、プロトコル定義のグローバルへのポインター。 この情報は、ルーティング プロトコルに対してプライベートです。
[in] StructureVersion
GlobalInfo パラメーターによって指される情報構造のバージョンを指定します。 場合によっては、これはルーティング プロトコルのバージョンと同じです。
[in] StructureSize
GlobalInfo パラメーターによって指される各情報構造体のサイズを指定します。 一部の情報構造には可変長メンバーが含まれているので、ルーティング プロトコルは必ずしもバージョンからの情報のサイズを決定できるとは限りません。
[in] StructureCount
GlobalInfo パラメーターによって指される情報構造体の数を指定します。 このパラメーターは常に 1 つです。
戻り値
関数が成功し、プロトコルがインターフェイス情報を受け取る準備ができた場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 説明 |
|---|---|
|
ルーティング プロトコルを初期化できませんでした。 |
|
GlobalInfo パラメーターが指すパラメーターの 1 つが無効です。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | routprot.h |