ConfigurePortUI 関数 (winsplp.h)

[アーティクル]
02/27/2024

ポートモニター UI DLL の ConfigurePortUI 関数は、ユーザーからポート構成情報を取得し、ポートモニターサーバー DLL に送信します。

構文

BOOL WINAPI pfnConfigurePortUI(
  _In_opt_ PCWSTR pszServer,
  _In_     HWND   hWnd,
  _In_     PCWSTR pszPortName
);

パラメーター

[in, optional] pszServer

サーバー名を表す文字列への呼び出し元指定のポインター。プリンターがローカルの場合は NULL 。 (ポートモニターはこのパラメーターを無視できます)。

[in] hWnd

ダイアログボックスの親として使用する必要があるウィンドウの呼び出し元によって指定されたハンドル。 NULL の場合、ダイアログボックスは表示されません。

[in] pszPortName

構成するポートの名前を表す文字列への呼び出し元指定のポインター。

戻り値

操作が成功した場合、関数は TRUE を返す必要があります。それ以外の場合は 、FALSE を返す必要があります。操作がサポートされていない場合、またはユーザーによって取り消された場合 ([キャンセル] を選択するか、構成パラメーターを変更せずに [OK] を選択します)、関数は SetLastError(ERROR_CANCELLED) を呼び出し、 FALSE を返します。

注釈

ポートモニター UI DLL は、 ConfigurePortUI 関数を定義し、 MONITORUI 構造体に関数のアドレスを含めるために必要です。

クライアントのスプーラーは、ConfigurePort 関数内から ConfigurePortUI を呼び出します (Microsoft Windows SDKドキュメントで説明されています)。 ConfigurePortUI で受け取る引数は、ConfigurePort によって受け取られた引数です。

関数は、次の操作を実行する必要があります。

OpenPrinter を呼び出し、プリンター名を次の形式で指定します。

\\ServerName\,XcvPortPortName

ここで 、ServerName と PortName は、 ConfigurePortUI 関数引数として受け取るサーバー名とポート名です。

OpenPrinter の呼び出しには、Windows SDKドキュメントで説明されているPRINTER_DEFAULTS構造が必要です。構造体の DesiredAccess メンバーは、SERVER_ACCESS_ADMINISTERに設定する必要があります。 その pDatatype メンバーと pDevMode メンバーは NULL にすることができます。

この呼び出しにより、印刷モニターサーバー DLL の XcvOpenPort 関数が呼び出されます。
ダイアログボックスを表示して、ユーザーからポート構成パラメーターを取得します。
XcvData を 1 回以上呼び出し、カスタマイズされたデータ名文字列を指定して、各構成パラメーターをサーバー DLL に送信します。各 XcvData 呼び出しにより、サーバーの XcvDataPort 関数が呼び出されます。
OpenPrinter から受信したハンドルを指定して ClosePrinter を呼び出します。これにより、サーバー DLL の XcvClosePort 関数が呼び出されます。