XcvOpenPort 関数 (winsplp.h)

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

ポートモニターサーバー DLL の XcvOpenPort 関数は、構成操作用のポートを開きます。

構文

BOOL XcvOpenPort(
  LPCWSTR     pszObject,
  ACCESS_MASK GrantedAccess,
  PHANDLE     phXcv
);

パラメーター

pszObject

ポートの名前を表す文字列への呼び出し元指定のポインター。 NULL を指定でき、ほとんどのモニターではこのパラメーターは必要ありません。

GrantedAccess

印刷モニター UI DLL がスプーラーの OpenPrinter 関数を呼び出す際にユーザーに付与されるアクセス権を含む呼び出し元指定のACCESS_MASK構造体。次の「備考」セクションを参照してください。

phXcv

関数指定のポートハンドルを受け取る場所への呼び出し元提供のポインター。

戻り値

操作が成功した場合、関数は TRUE を返す必要があります。それ以外の場合は 、FALSE を返す必要があります。

注釈

XcvOpenPort 関数を定義し、そのアドレスをMONITOR2構造に含めるには、ポートモニターサーバー DLL が必要です。

指定したプリンター名に "XcvPort" または "XcvMonitor" のいずれかの文字列が含まれている場合、スプーラーの OpenPrinter 関数 (Microsoft Windows SDK ドキュメントで説明) は XcvOpenPort を呼び出します。詳細については、「 AddPortUI」を参照してください。

XcvOpenPort 関数は、構成目的でポートを開く必要があります。この操作は、 XcvDataPort 内で後続の使用のために入力引数を格納することのみで構成される場合があります。関数は、 phXcv が指す場所に格納されている情報へのハンドルを返す必要があります。このハンドルは OpenPrinter の呼び出し元に返され、その後 XcvDataPort への入力引数として受け取られます。

この関数は、付与されたアクセスマスクを保存する必要があります。その後、サーバー DLL の XcvDataPort 関数が呼び出されると、許可されたアクセスをSERVER_ACCESS_ADMINISTERと比較し、比較が失敗した場合、 XcvDataPort はERROR_ACCESS_DENIEDを返す必要があります。