GET PRINT OPTION

4D v15.4

GET PRINT OPTION


GET PRINT OPTION ( option ; value1 {; value2} )

引数	型	説明
option	倍長整数, 文字	オプション番号
value1	倍長整数, 文字	オプションの値1
value2	倍長整数	オプションの値2

説明

GET PRINT OPTION コマンドは、プリントオプションの現在の値を返します。

option引数を使用して取得するオプションを指定することができます。“Print Options”テーマ内にある定義済定数のいずれか (倍長整数)、またはPDFオプションコード (文字列) を渡すことができます:

オプション定数は以下の通りです:

定数	型	値	コメント
Paper option	倍長整数	1	value1 のみを使用した場合、ここには用紙の名前のみが含まれます。両方の引数を使用した場合、value1 には用紙の幅が、value2 には用紙の高さが含まれます。幅と高さはどちらもスクリーンピクセルで表現されます。プリンターで使用できる全ての用紙フォーマットの名前、高さと幅を取得する場合にはPRINT OPTION VALUES コマンドを使用して下さい。
Orientation option	倍長整数	2	value1 のみ:1=縦向き、2=横向き。異なるページ方向が使用されている場合、GET PRINT OPTIONコマンドはvalue1に0を返します。 64-bit 版のみ: このオプションは印刷ジョブ内から呼び出す事が可能なので、同一印刷ジョブ中において縦向きを横向きに、あるいはその逆へと切り替えることが可能です。
Scale option	倍長整数	3	value1 のみ: 拡大縮小の倍率の値(パーセント)。一部のプリンターでは倍率の変更を許可していないものもあるという点に注意して下さい。無効な値を渡した場合、プロパティは印刷時に100%へとリセットされます。
Number of copies option	倍長整数	4	value1 のみ: 印刷する部数
Paper source option	倍長整数	5	(Windows のみ) value1 のみ: コマンドで返されるトレイの配列の中で、使用される予定の用紙トレイのインデックスに対応する番号。このオプションはWindowsでのみ使用可能です。
Color option	倍長整数	8	(Windows のみ) value1 のみ: カラーを管理するモードを指定するコード: 1=白黒(モノクロ)、2=カラー 64-bit 版: このオプションは64-bit版の4Dではサポートされていません。(廃止予定)
Destination option	倍長整数	9	value1: 印刷先のタイプを指定するコード: 1=プリンター、2=(PC)/PS ファイル(Mac)、3=PDFファイル、5=スクリーン(OS X ドライバーオプション)。 value1 が1あるいは5以外であった場合、value2 には生成されたドキュメントへのパス名が含まれます。このパスは他のパスが指定されるまでは使用され続けます。保存先に同じ名前のファイルが既に存在していた場合には、それは置き換えられます。GET PRINT OPTIONの場合、カレントの値が既定のリスト内にない場合、value1 には-1が返され、OKシステム変数は1に設定されます。エラーが起きた場合、value1 とOKシステム変数は0に設定されます。注: Windowsにおいては、PDF Creatorドライバーがインストールされていた場合には印刷先を3(PDFファイル)に設定することができます。(9;3;path) の値が渡された場合、4Dは自動的に"サイレント"PDF印刷を開始します。この場合には、渡されたオプションコードであればどれでも受け取ります(value2 に空の文字列を渡すかこの引数を省略した場合、印刷時にファイルを保存ダイアログが表示されるという点に注意して下さい)。印刷後、カレントの設定は保存されます。これは4DのPDF印刷の管理を簡略化し、ユーザーがマルチプラットフォームなコードを書けるようにします。(9;3;path)値が渡されなかった場合、印刷は4Dによって管理されず、渡されたPDF Creatorオプションコードはどれも無視されます。
Double sided option	倍長整数	11	(Windows のみ) value1: 0=片側印刷あるいは標準、1=両面印刷。value1=1のとき、value2 にはページ綴じの設定が含まれます: 0=左綴じ(デフォルト値)、1=上綴じ注: このオプションはWindows環境においてのみ使用可能です。
Spooler document name option	倍長整数	12	value1 のみ: スプーラドキュメントの一覧に表示される、カレントの印刷ドキュメント名。この宣言によって定義される名前は、新しい名前あるいは空の文字列が渡されない限りはセッションで印刷される全てのドキュメントに対して使用されます。標準のオペレーション(メソッドの場合にはメソッド名を、レコードの場合にはテーブル名を使用)を使用あるいは復元するためには、空の文字列をvalue1 に渡して下さい。
Mac spool file format option	倍長整数	13	(Mac のみ) value1 のみ: 0=PDFモードでジョブを印刷(デフォルト値)　1=PostScriptモードでジョブを印刷注: - このオプションはWinodws環境下では何の効力も持ちません。 - OS Xでは、印刷はデフォルトでPDFで行われます。しかしながら、PDF印刷ドライバは格納されたPostScript情報をもつPICTフォーマットのピクチャーをサポートしません。これらのピクチャーは具体的にはヴェクター式の描画ソフトウェアによって生成されます。このような問題を避けるため、このオプションではOS X環境下のカレントのセッションで使用するために、印刷モードを変更することができます。ただしPostScriptモードでの印刷には予期せぬ副作用を引き起こす可能性がある点に注意して下さい。 64-bit 版: このオプションはサポートされていません。代わりに、SET CURRENT PRINTER コマンドのGeneric PDF driver オプションで置き換えられています。
Hide printing progress option	倍長整数	14	value1 のみ: 1=進捗ウィンドウを非表示、0=進捗ウィンドウを表示(デフォルト)。このオプションは、特にOS XでのPDF印刷の際に有用です。注: データベース設定ダイアログボックス内には、既に印刷プログレスオプションがあります(インターフェースページ内)。しかしながら、この設定は全体に適用され、OS X環境下でのウィンドウを全て非表示にするわけではありません。

PDFオプションコードは2つの部分、OptionTypeとOptionNameからなり、"OptionType:OptionName"のように組み合わせて使用します。

このコマンドは、指定したoptionの現在の値をvalue1と (オプションの) value2に返します。

オプション、PDFオプションコード、および考えられる値に関する詳細は、SET PRINT OPTIONコマンドの説明を参照してください。

次に示すGET PRINT OPTIONコマンド特定の機能に注意してください:

option = 1 (paper option): value2を省略した場合、value1には現在の用紙名が返されます。value2を渡した場合、このコマンドは用紙の高さと幅をそれぞれvalue1とvalue2に返します。プリンタが提供するすべての用紙フォーマットの名前、高さ、幅を取得するには、PRINT OPTION VALUESコマンドを使用してください。
option = 2 (orientation option): 1 (縦方向) または2 (横方向) が返されます。異なる方向オプションが使用されている場合、value1には0が代入されます。
option = 5 (paper source option): value1には使用する用紙トレイの (PRINT OPTION VALUESコマンドから返されたトレイ配列の) インデックスが返されます (value2は必ず省略してください) 。
Note: このオプションはWindows上でのみ使用できます。
option = 8 (color option): value1にはカラー処理モードを表わすコードが返されます (1= 白黒、2=カラー) 。
Note: このオプションはWindows上でのみ使用できます。
option = 9 (destination option): 定義済リスト上に現在の値が存在しない場合、value1には-1が代入され、システム変数OKには1がセットされます。エラーが発生した場合、value1とシステム変数OKには0が代入されます。value1に1または5以外の定義済の値が代入されている場合、value2には印刷されたファイルのアクセスパスが納められます。
option = 11 (double sided option): value1に、0 (デフォルト値である標準か片面印刷) または1 (両面) が返されます。value1が1の場合、value2には0=左とじ (デフォルト) または1=上とじのいずれかの値が返されるかもしれません。
Note: このオプションはWindows上でのみ使用できます。
option = 12 (spooler document name option): 事前に定義されている場合、value1には現在の印刷文書の名前が返されます。事前定義されていない場合には、空の文字列が返されます。

Note: GET PRINT OPTION コマンドは主にPostScript プリンターをサポートします。このコマンドは他のタイプのプリンター、例えばPCLやlinkなどにも使用できますが、その場合一部のオプションが使用できない可能性があります。

システム変数およびセット

このコマンドが正しく実行されると、OKシステム変数に1が、そうでなければ0が設定されます。

参照

PRINT OPTION VALUES
SET PRINT OPTION