WTSCreateListenerA 関数 (wtsapi32.h)

新しいリモート デスクトップ サービス リスナーを作成するか、既存のリスナーを構成します。

構文

BOOL WTSCreateListenerA(
  [in] HANDLE              hServer,
  [in] PVOID               pReserved,
  [in] DWORD               Reserved,
  [in] LPSTR               pListenerName,
  [in] PWTSLISTENERCONFIGA pBuffer,
  [in] DWORD               flag
);

パラメーター

[in] hServer

RD セッション ホスト サーバーへのハンドル。 このパラメーターは常に WTS_CURRENT_SERVER_HANDLEに設定してください。

[in] pReserved

このパラメーターは予約されています。 このパラメーターは常に NULL に設定してください。

[in] Reserved

このパラメーターは予約されています。 常に、このパラメーターを 0 に設定します。

[in] pListenerName

作成または構成するリスナーの名前を含む null で終わる文字列へのポインター。

[in] pBuffer

リスナーの構成情報を含む WTSLISTENERCONFIG 構造体へのポインター。

[in] flag

呼び出しの目的。 このパラメーターには、次の値のいずれかを指定できます。

WTS_LISTENER_CREATE (1 (0x1))

新しいリスナーを作成します。

WTS_LISTENER_UPDATE (16 (0x10))

既存のリスナーの設定を更新します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。 エラーの詳細情報を得るには、GetLastError 関数を呼び出します。

注釈

この関数は、 リモート デスクトップ プロトコル (RDP) を使用するリスナーを作成または構成します。 pBuffer パラメーターが指す WTSLISTENERCONFIG 構造体のバージョン メンバーを常に 1 に設定します。

この関数は、リスナーのセキュリティ記述子を作成または構成しません。 この関数を呼び出して新しいリスナーを作成すると、関数は新しいリスナーに既定のセキュリティ記述子を割り当てます。 セキュリティ記述子を変更するには、 WTSSetListenerSecurity 関数を呼び出します。 セキュリティ記述子の詳細については、「 SECURITY_DESCRIPTOR」を参照してください。

この関数は、新しいリスナーの設定を検証しません。 この関数を呼び出す前に、設定が有効であることを確認してください。

注意

wtsapi32.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして WTSCreateListener を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 7
サポートされている最小のサーバー	Windows Server 2008 R2
対象プラットフォーム	Windows
ヘッダー	wtsapi32.h
Library	Wtsapi32.lib
[DLL]	Wtsapi32.dll

関連項目

SECURITY_DESCRIPTOR

SECURITY_INFORMATION

WTSLISTENERCONFIG

WTSSetListenerSecurity