DeletePortUI 関数 (winsplp.h)

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

ポートモニター UI DLL の DeletePortUI 関数は、プリンターポートを削除します。

構文

BOOL DeletePortUI(
  [in, optional] PCWSTR pszServer,
  [in]           HWND   hWnd,
  [in]           PCWSTR pszPortName
);

パラメーター

[in, optional] pszServer

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

[in] hWnd

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

[in] pszPortName

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

戻り値

操作が成功した場合、関数は TRUE を返す必要があります。それ以外の場合は 、FALSE を返す必要があります。操作がユーザーによって取り消された場合、またはサポートされていない場合、関数は SetLastError(ERROR_CANCELLED) を呼び出し、 FALSE を返す必要があります。

注釈

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

スプーラーは 、DeletePort 関数内から DeletePortUI を 呼び出します。 DeletePortUI で受け取る引数は、DeletePort で受け取る引数です。 (DeletePort 関数は、Microsoft Windows SDKドキュメントで説明されています)。

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

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

\\ServerName\,XcvPortPortName

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

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

この呼び出しにより、印刷モニターサーバー DLL の XcvOpenPort 関数が呼び出されます。
次の入力引数を指定して XcvData を呼び出します。
- OpenPrinter から受け取ったハンドル
- 関数引数として受け取ったポート名
- "DeletePort" のデータ名文字列
この呼び出しにより、サーバー DLL の XcvClosePort 関数が呼び出されます。
ユーザーの操作が必要な場合は、ダイアログボックスを表示してユーザーから情報を取得し、カスタマイズされたデータ名文字列を指定して XcvData を呼び出して、サーバー DLL に情報を送信します。 XcvData 呼び出しにより、サーバーの XcvDataPort 関数が呼び出されます。
OpenPrinter から受信したハンドルを指定して ClosePrinter を呼び出します。これにより、サーバー DLL の XcvClosePort 関数が呼び出されます。