パラメーターの形式および説明

char cShortSessionID
表示スペースの短縮セッション ID。
PRINTINFO * const pPrintInfo
プリンター設定値が指定される PRINTINFO 構造体へのポインター。
nFlags
0 を設定する必要があります。この値は無視されます。
nBufSize
以下のフィールドに割り振られるバッファーのサイズ。
  • lpPDTFile
  • lpPrtToDskAppFile
  • lpPrtToDskSepFile
  • lpPrinterName
単一の API 呼び出しで、複数のメンバーが検索される場合、 呼び出し側は、すべてのバッファーに同じサイズを割り振り、このメンバー にそのサイズを渡す必要があります。

このメンバーが 0 に設定されている場合、フィールドは無視されます。フィールドのバッファーに必要な最大サイズは、nSizeNeeded に戻されま す。

nSizeNeeded
このメンバーの値は、以下のフィールドに関連する条件によって決 まります。
  • lpPDTFile
  • lpPrtToDskAppFile
  • lpPrtToDskSepFile
  • lpPrinterName
条件は、以下のとおりです。
  • 呼び出し側によって割り振られたバッファーのサイズが、上記にリスト したフィールドを戻すのに十分でない場合、この値は、必要なバイト数になる。
  • 上記にリストしたフィールドの複数が呼び出し側によって取得され る場合、この値は、必要バッファーの最大サイズになる。
  • nBufSize が呼び出し側によって 0 に設定されている場合、このメン バーには、上にリストしたフィールドのバッファーに必要な最大サイズが含 まれる。
bPromptDialog
以下の値を指定できます。
  • TRUE の場合、印刷の前に「プリンター設定」ダイアログが表示されます。
  • FALSE の場合、印刷の前に「プリンター設定」ダイ アログは表示されません。
bPDTMode
以下の値を指定できます。
  • TRUE の場合、ホスト・セッションは PDT モードになります。
  • FALSE の場合、ホスト・セッションは非 PDT モード (GDI モード) になります。
lpPDTFile
呼び出し側がこのメンバーを取得しない場合は、NULL に設定されて いる必要があります。ヌル・ポインターでない場合は、PDT ファイルが戻されます。このメンバーは、呼び出し側によって割り振られたサイズ nBufSize のバッファーを指している必要があります。
API が戻るとき、このメンバーには以下のいずれかが含まれています。
  • セッション PDT ファイルの完全修飾パス名。
  • セッションで PDT ファイルが構成されていない場合は、空ストリング ("")。
  • バッファー・サイズが十分でない場合は、切り捨てられたファイル名。メンバー nSizeNeeded に、必要なバッファー・サイズが含まれています。
nPrtMode
これは、接続の PrintMode を示す列挙値です。列挙データ型 PRINTMODE は、PCSAPI32.H に定義されています。 nPrtMode 設定値は、以下のいずれかでなければなりません。
  • PrtToDskAppend (ディスクへの印刷 - 付加モード)

    これは、ホスト・セッションの「プリンター設定」→「プリンター」→「ディスクへの印刷」ダイアログで「付加」オプションを選択することと同じです。

  • PrtToDskSeparate (ディスクへの印刷 - 別個モード)

    これは、ホスト・セッションの「プリンター設定」→ 「プリンター」→ 「ディスクへの印刷」ダイアログで「別個」オプションを選択することと同じです。

  • WinDefaultPrinter (Windows デフォルト・プリンター・モード)

    これは、ホスト・セッションの「プリンター設定」ダイアログで「Windows デフォルト・プリンターを使用」オプションを選択することと同じです。

  • SpecificPrinter (特定プリンター・モード)

    これは、ホスト・セッションの「プリンター設定」ダイアログで、「Windows デフォルト・プリンターを使用」オプションのチェックを外した状態でプリンターを選択するのと同じです。

lpPrtToDskAppFile
呼び出し側がこのメンバーを取得しない場合は、NULL に設定されて いる必要があります。ヌル・ポインターでない場合は、Print to Disk-Append ファイルが戻されます。このメンバーは、呼び出し側によって割り振られたサイズ nBufSize のバッファーを指している必要があります。
API が戻るとき、このメンバーには以下のいずれかが含まれています。
  • セッションの Print to Disk-Append ファイルの完全修飾パス名。
  • セッションに Print to Disk-Append ファイルが構成されていない場合は、空ストリング ("")。
  • バッファー・サイズが十分でない場合は、切り捨てられたファイル名。nSizeNeeded メンバーに、必要なバッファー・サイズが含まれています。
lpPrtToDskSepFile
呼び出し側がこのメンバーを取得しない場合は、NULL に設定されて いる必要があります。ヌル・ポインターでない場合は、Print to Disk-Separate ファイルが戻されます。このメンバーは、呼び出し側によって割り振られたサイズ nBufSize のバッファーを指している必要があります。
API が戻るとき、このメンバーには以下のいずれかが含まれています。
  • セッションの Print to Disk-Separate ファイルの完全修飾パス名。
  • セッションで、Print to Disk-Separate ファイルが構成されていない場合は、空ストリング ("")。
  • バッファー・サイズが十分でない場合は、切り捨てられたファイル名。nSizeNeeded メンバーに、必要なバッファー・サイズが含まれています。
lpPrinterName
呼び出し側がこのメンバーを取得しない場合は、NULL に設定されて いる必要があります。ヌル・ポインターでない場合は、プリンター名が戻され ます。このメンバーは、呼び出し側によって割り振られたサイズ nBufSize のバッファーを指している必要があります。
API が戻るとき、このメンバーには以下のいずれかが含まれています。
  • ホスト・セッション nPrtMode が SpecificPrinter である場合は、セ ッションで構成されている特定プリンターの名前。
  • ホスト・セッション nPrtMode が WinDefaultPrinter である場合は、 セッションで構成されている Windows デフォルト・プリンターの名前。
  • ホスト・セッション nPrtMode が PrtToDskAppend または PrtToDskSeparate である場合は、空ストリング ("")。
  • バッファー・サイズが十分でない場合は、切り捨てられたプリンター名。nSizeNeeded メンバーに、必要なバッファー・サイズが含まれています。
プリンター名の形式は次のとおりです。
<Printer name> on <Port Name>
例:
  • IBM InfoPrint 40 PS on Network Port
  • HP LaserJet 4050 Series PCL 6 on LPT1
ULONG * const pErrorInfo
API が戻りコード PCS_FAILURE で失敗した場合に、詳細なエラー情報が記載されます。 エラーの詳細が必要ない場合、pErrorInfo は、呼び出し側によって NULL に設定される必要があります。

以下のセクションで、PCSAPI32.H で定義されているフラグを説明します。