MprAdminServerSetInfo 関数 (mprapi.h)

[アーティクル]
08/24/2023

MprAdminServerSetInfo 関数は、RRAS サービスの実行時に L2TP、PPTP、および SSTP デバイスのポート数を設定するために使用されます。

構文

DWORD MprAdminServerSetInfo(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] DWORD             dwLevel,
  [in] LPBYTE            lpbBuffer
);

パラメーター

[in] hMprServer

クエリを実行するルーターを処理します。 MprAdminServerConnect を呼び出して、このハンドルを取得します。

[in] dwLevel

lpbBuffer パラメーターで情報を構造化する形式を表す DWORD 値。 dwLevel に使用できる値は、次の表に示すように 1 と 2 です。

値	構造体の形式
1	Windows Server 2003 以降: MPR_SERVER_1
2	Windows Server 2008 以降: MPR_SERVER_2

[in] lpbBuffer

MPR_SERVER_1へのポインター
または MPR_SERVER_2 構造体。 dwLevel パラメーターは、構造体の種類を示します。

戻り値

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

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

値	意味
ERROR_ACCESS_DENIED	呼び出し元のアプリケーションに十分な特権がありません。
ERROR_SUCCESS_REBOOT_REQUIRED	このような変更を反映するには、システムの再起動が必要です。 MprConfigServerSetInfo 呼び出しと再起動を使用してポート数を変更します。
ERROR_INVALID_PARAMETER	MPR_SERVER_1トピックおよび MPR_SERVER_2トピックで定義されているように、ポートの数をシステムでサポートされている制限を超える数に設定しようとするとします。 PPTP ポートの数を 0 に設定しようとすると、このエラーが返されます。フラグが無効な場合、または lpbBuffer または hMprServer が NULL の場合、このエラーを返します。
ERROR_DDM_NOT_RUNNING	このサーバーで RRAS サービスが実行されていません。
ERROR_NOT_SUPPORTED	dwLevel の値が無効です。
ERROR_INVALID_HANDLE	hMprServer ハンドルが無効です。
その他	FormatMessage を使用して、返されたエラーコードに対応するシステムエラーメッセージを取得します。

注釈

この関数は、L2TP、PPTP、および SSTP ポートのポート数を設定し、サービスの実行中に RRAS を有効または無効にするために使用されます。これらの値は永続的です。つまり、 MprConfigServerSetInfo の呼び出しでこの呼び出しに従う必要はありません。この関数は非同期であるため、変更の影響がすぐには表示されない場合があることに注意してください。

例

トピック「ローカル RRAS サービスの L2TP ポートと PPTP ポートの設定」では、この機能の使用中を示します。

要件

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