WritePort 関数 (winsplp.h)

ポートモニターの WritePort 関数は、プリンターポートにデータを書き込みます。

構文

BOOL WritePort(
  _In_  HANDLE  hPort,
  _In_  LPBYTE  pBuffer,
        DWORD   cbBuf,
  _Out_ LPDWORD pcbWritten
);

[in] hPort

呼び出し元が指定したポートハンドル。

[in] pBuffer

ポートに書き込まれるデータを含むバッファーへの呼び出し元指定ポインター。

cbBuf

pBuffer の呼び出し元が指定したサイズ (バイト単位)。

[out] pcbWritten

ポートに正常に書き込まれたバイト数を受信する場所への呼び出し元指定ポインター。

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

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

関数の hPort 引数として受け取るハンドルは、モニターの OpenPort 関数または OpenPortEx 関数が指定したポートハンドルです。

通常、言語モニターの WritePort 関数は、 pBuffer が指すバッファーに含まれるデータストリームに言語固有のコマンドを追加し、変更されたデータストリームをポートモニターの WritePort 関数に渡します。

ポートモニターサーバー DLL のWritePort関数は、通常、WriteFile を呼び出して (Microsoft Windows SDKのドキュメントに記載されています)、カーネルモードのポートドライバーにデータストリームを送信します。

一般的な印刷ジョブは、への WritePort複数の呼び出しで構成されます。各呼び出しには、異なる cbBuf 値を指定できます。

関数は 、pcbWritten が指す位置に数値を配置することで、正常に書き込まれたバイト数を返す必要があります。言語モニターの場合、この数値には、データストリームに追加された言語固有の余分なバイト数を含めてはなりません。

スプーラーは、返されたバイト数ではなく、の戻り値をチェック WritePortして、書き込み操作の成功または失敗を判断します。したがって、返されるバイト数が 0 の場合、関数が FALSE を返さない限り、失敗した書き込みを表すわけではありません。

ある種のシステム実装またはモニター実装のタイムアウトメカニズムでは、スプーラーの停止を回避するために、関数が妥当な時間内に返されるように WritePort する必要があります。

言語モニターは、StartDocPort/EndDocPort ペアの外部でポートモニターのWritePortルーチンを呼び出すことができます。ただし、一部のポートモニターではこのような呼び出しが失敗する可能性があるため、このエラーを処理するには言語モニターを記述する必要があります。