DeletePersistentUdpPortReservation 関数 (iphlpapi.h)

  • [アーティクル]

DeletePersistentUdpPortReservation 関数は、ローカル コンピューター上の連続する TCP ポート ブロックの永続的な TCP ポート予約を削除します。

構文

IPHLPAPI_DLL_LINKAGE ULONG DeletePersistentUdpPortReservation(
  [in] USHORT StartPort,
  [in] USHORT NumberOfPorts
);

パラメーター

[in] StartPort

ネットワーク バイト順の開始 UDP ポート番号。

[in] NumberOfPorts

削除する UDP ポート番号の数。

戻り値

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

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

リターン コード 説明
ERROR_ACCESS_DENIED
 アクセスが拒否されました。 このエラーは、次のようないくつかの条件で返されます。ユーザーがローカル コンピューターで必要な管理特権を持っていないか、アプリケーションが組み込みの管理者 (RunAs 管理者) として拡張シェルで実行されていません。
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。 このエラーは、StartPort パラメーターまたは NumberOfPorts パラメーターに 0 が渡された場合に返されます。
ERROR_NOT_FOUND
 要素が見つかりませんでした。 StartPort パラメーターと NumberOfPorts パラメーターで指定された永続的なポート ブロックが見つからなかった場合、このエラーが返されます。
その他
 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

解説

DeletePersistentUdpPortReservation 関数は、Windows Vista 以降で定義されています。

DeletePersistentUdpPortReservation 関数は、UDP ポートのブロックの永続的な予約を削除するために使用されます。

DeletePersistentUdpPortReservation 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。 Administrators グループのメンバーではないユーザーが DeletePersistentUdpPortReservation を呼び出すと、関数呼び出しは失敗し、 ERROR_ACCESS_DENIED が返されます。 この関数は、Windows Vista 以降のユーザー アカウント制御 (UAC) が原因で失敗する可能性もあります。 この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、 requestedExecutionLevel が requireAdministrator に設定されたマニフェスト ファイルでアプリケーションがマークされていない限り、この呼び出しは失敗します。 アプリケーションにこのマニフェスト ファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーは、この関数を成功させるために、組み込みの Administrator (RunAs 管理者) として拡張シェルでアプリケーションを実行する必要があります。

要件

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

関連項目

CreatePersistentTcpPortReservation

CreatePersistentUdpPortReservation

DeletePersistentTcpPortReservation

LookupPersistentTcpPortReservation

LookupPersistentUdpPortReservation