8-2-2　使用するオプション（C版）

UCXSingle C版をコマンドプロンプトで実行する場合、またはUCXSingle C版をプログラム内で使用する場合のオプションは次のとおりです。

オプション名	機能	SVF Cloud連携時の使用可否
-8/--utf8	データファイルがUTF-8フォーマットの場合に指定します。
-a/--auth-file	BASIC認証、DIGEST認証を行うための認証情報を設定します。
-b/--date-format	ログの日時書式を設定します。
-c/--data-encoding	データファイルのエンコーディングを指定します。
-D/--adjustd	1/400ドット単位で印字位置を調整します。
-M/--adjustm	1/10ミリ単位で印字位置を調整します。
-d/--delete	処理後、データファイルを削除します。
-f/--not-utf8	データファイルがUTF-8フォーマットでない場合に指定します。
-F/--file-transfer-only	サーバー側へデータファイル転送し、その通知をサーバーから受け取ってサーバーでの処理終了結果を待たずに終了します。
-g/--getfile	SVF製品により生成された出力ファイルをクライアントにダウンロードする際、同一ファイル名があった場合は上書きせずにユニークなファイル名を付けます。
-G/--getfile-overwrite	SVF製品により生成された出力ファイルをクライアントにダウンロードする際、同一ファイル名があった場合は上書きします。
-h/--target-host	Universal Connect/Xサーバーのホスト名、IPアドレス、またはHTTP/HTTPS通信で接続するUniversal Connect/X中継サーバーのURLのいずれかを指定します。
-k/--keepalive	秒単位でキープアライブ時間を指定します。
-K/--keep-file-and-show-total-pages	1JOB間の印刷ページ数を、ファイル出力した上で取得します。
-l/--logfile	処理実行時のログを出力します。
-n/--nolog	処理実行時のログを出力しません。
-N/--show-document-number	RDEにスプールする際の文書管理番号を取得します。
-p/--port	Universal Connect/Xサーバーのポート番号を指定します。
-r/--undelete-on-error	処理が異常終了した場合にデータファイルを削除せず残します。
-s/--show-created-file-name	SVF製品により生成された出力ファイルのファイル名を表示します。
-t/--timeout	秒単位でタイムアウト時間を指定します。
-T/--show-total-pages	1JOB間の印刷ページ数のみ取得し、ファイル出力はしません。
-u/--undelete	処理後、データファイルを削除せずに残します。
-v/--version	UCXSingleのバージョンを表示します。
-z/--zip	Universal Connect/Xサーバーとファイルを送受信する際に、ファイルを圧縮します。
--help	ヘルプを表示します。

-8/--utf8

機能	データファイルがUTF-8フォーマットの場合に指定します。
書式	UCXSingle -8
引数	なし

-a/--auth-file

機能	BASIC認証、DIGEST認証を行うための認証情報を設定します。
書式	UCXSingle -a filename
引数	filename 認証用のファイル名

参考

指定する認証用のファイルには、1行目にユーザー名、2行目にパスワードを記載します。
認証用のファイル名として、ピリオド1つ「.」を指定した場合は、カレントディレクトリの「.ucxauth」というファイルを使用します。

-b/--date-format

機能	ログの日時書式を設定します。
書式	UCXSingle -b pattern
引数	pattern 日時書式

参考

pattern（日時書式）の指定は、strftime書式を参考に記述します。

-c/--data-encoding

機能	データファイルのエンコーディングを指定します。
書式	UCXSingle -c MS932

参考

設定がない場合には、動作設定の設定に従います。

-D/--adjustd

機能	1/400ドット単位で印字位置を調整します。
書式	UCXSingle -D x, y (調整値)
引数	x 左右調整値（正=右方向、負=左方向） y 上下調整値（正=下方向、負=上方向）

注意

様式ファイル、SVF環境設定、データファイルの<start><end>タグ内で印字位置の設定があった場合には合計値が設定されます。

制限

オプション-Dとオプション-Mは同時に使用できません。

-M/--adjustm

機能	1/10ミリ単位で印字位置を調整します。
書式	UCXSingle -M x,y (調整値)
引数	x 左右調整値（正=右方向、負=左方向） y 上下調整値（正=下方向、負=上方向）

注意

様式ファイル、SVF環境設定、データファイルの<start><end>タグ内で印字位置の設定があった場合には合計値が設定されます。

制限

オプション-Dとオプション-Mは同時に使用できません。

-d/--delete

機能	処理後、データファイルを削除します。
書式	UCXSingle -d 動作設定のJobID {データファイル名またはURL}
引数	なし

注意

オプション-dは、データファイル名を指定した場合に有効です。

-f/--not-utf8

機能	データファイルがUTF-8フォーマットでない場合に指定します。
書式	UCXSingle -f
引数	なし

-F/--file-transfer-only

機能	サーバー側へデータファイル転送し、その通知をサーバーから受け取ってサーバーでの処理終了結果を待たずに終了します。
書式	UCXSingle -F
引数	なし

制限

オプション-gおよびオプション-Gは同時に使用できません。
オプション-Fは、UCXSingle側からUniversal Connect/Xサーバーへデータファイルを転送しない場合、使用できません。
オプション-Fを指定すると、サーバーから転送完了通知を受け取った後、通信を切断するため、その後の処理結果はサーバーから受け取りません。印刷処理自体はサーバー上で継続、終了します。

-g/--getfile

機能	SVF製品により生成された出力ファイルをクライアントにダウンロードする際、同一ファイル名があった場合は上書きせずにユニークなファイル名を付けます。このオプションを使用すると、ジョブの文書分割とメール送信はできなくなります。
書式	UCXSingle -g filename 動作設定のJobID {データファイル名またはURL}
引数	filename ファイル名

機能

SVF製品により生成された出力ファイルをクライアントにダウンロードする際、同一ファイル名があった場合は上書きせずにユニークなファイル名を付けます。

このオプションを使用すると、ジョブの文書分割とメール送信はできなくなります。

書式

UCXSingle -g filename 動作設定のJobID {データファイル名またはURL}

引数

filename
ファイル名

注意

-g(--getfile)オプションを省略した場合は、出力方法は動作設定に従います。
フルパスで指定できます。
オプション-Fは同時に使用できません。
UNC名に対応していないため、UNC名での指定はできません。

-G/--getfile-overwrite

機能	SVF製品により生成された出力ファイルをクライアントにダウンロードする際、同一ファイル名があった場合は上書きします。このオプションを使用すると、ジョブの文書分割とメール送信はできなくなります。
書式	UCXSingle -G filename 動作設定のJobID {データファイル名またはURL}
引数	filename ファイル名

機能

SVF製品により生成された出力ファイルをクライアントにダウンロードする際、同一ファイル名があった場合は上書きします。

このオプションを使用すると、ジョブの文書分割とメール送信はできなくなります。

書式

UCXSingle -G filename 動作設定のJobID {データファイル名またはURL}

引数

filename
ファイル名

注意

フルパスで指定できます。
オプション-Fは同時に使用できません。
UNC名に対応していないため、UNC名での指定はできません。

-h/--target-host

機能	Universal Connect/Xサーバーのホスト名、IPアドレス、またはHTTP/HTTPS通信で接続するUniversal Connect/X中継サーバーのURLのいずれかを指定します。
書式	UCXSingle -h h_name 動作設定のJobID {データファイル名またはURL}
引数	h_name Universal Connect/Xサーバーのホスト名、IPアドレス、またはHTTP/HTTPS通信で接続する中継モジュール

参考

オプション-hを指定しない場合、ホスト名はlocalhostが適用されます。
-hオプションは、次のように指定します。HTTP（HTTPS）接続のURLでポートまで指定した場合、-pオプションは必要ありません。
ホスト名の場合
UCXSingle -h ホスト名 -p 44080
HTTP接続の場合
UCXSingle -h http://ホスト名:44090
HTTPS接続の場合
UCXSingle -h https://ホスト名:443
IPv6アドレスで-hオプションを指定することも可能です。
UCXSingle -h http://[IPv6アドレス]:44090

ホスト名の場合	UCXSingle -h ホスト名 -p 44080
HTTP接続の場合	UCXSingle -h http://ホスト名:44090
HTTPS接続の場合	UCXSingle -h https://ホスト名:443

-k/--keepalive

機能	秒単位でキープアライブ時間を指定します。
書式	UCXSingle -k sec 動作設定のJobID {データファイル名またはURL}
引数	sec キープアライブ時間

参考

キープアライブ動作とは、Universal Connect/Xサーバーに要求した印刷が完了するまでの間に、一定時間の間隔でサーバーより生存確認情報を通知することで、無応答状態を回避するUniversal Connect/Xサーバーの仕組みです。

注意

オプション-kを指定しない場合、キープアライブは無効です。
オプション-kを使用するにはタイムアウト時間の設定が必須です。設定タイムアウト時間でタイムアウトします。

-K/--keep-file-and-show-total-pages

機能	1JOB間の印刷ページ数を、ファイル出力した上で取得します。
書式	UCXSingle -K 動作設定のJobID {データファイル名またはURL}
引数	なし
戻り値	ページ数

制限

オプション-Tとオプション-Kは同時に使用できません。

-l/--logfile

機能	処理実行時のログを出力します。
書式	UCXSingle -l filename 動作設定のJobID {データファイル名またはURL}
引数	filename ログファイル名

-n/--nolog

機能	処理実行時のログを出力しません。
書式	UCXSingle -n 動作設定のJobID {データファイル名またはURL}
引数	なし

-N/--show-document-number

機能	RDEにスプールする際の文書管理番号を取得します。
書式	UCXSingle -N 動作設定のJobID {データファイル名またはURL}
引数	なし

注意

オプション-NはRDEがセットアップされている状態で、JOBの出力先がRDEであった場合のみ有効です。

-p/--port

機能	Universal Connect/Xサーバーのポート番号を指定します。
書式	UCXSingle -p p_no 動作設定のJobID {データファイル名またはURL}
引数	p_no Universal Connect/Xサーバーのポート番号

参考

オプション-pを指定しない場合、ポート番号は44080が適用されます。

-r/--undelete-on-error

機能	処理が異常終了した場合にデータファイルを削除せず残します。
書式	UCXSingle -r 動作設定のJobID {データファイル名またはURL}
引数	なし

注意

オプション-rは、データファイル名を指定した場合に有効です。

-s/--show-created-file-name

機能	SVF製品により生成された出力ファイルのファイル名を表示します。
書式	UCXSingle -s 動作設定のJobID {データファイル名またはURL}
引数	なし

-t/--timeout

機能	接続完了後、処理開始から処理完了の状態になるまでのタイムアウト時間を秒単位で指定します。
書式	UCXSingle -t sec 動作設定のJobID {データファイル名またはURL}
引数	sec タイムアウト時間

注意

オプション-tを指定しない場合、10分でタイムアウトします。処理量が多い場合は、タイムアウト値を延ばしてください。0は指定できません。

-T/--show-total-pages

機能	1JOB間の印刷ページ数のみ取得し、ファイル出力はしません。
書式	UCXSingle -T 動作設定のJobID {データファイル名またはURL}
引数	なし
戻り値	ページ数

注意

オプション-Tとオプション-Kは同時に使用できません。
スプールモードがファイル出力になっている場合のみファイル出力をしません。

-u/--undelete

機能	処理後、データファイルを削除せずに残します。
書式	UCXSingle -u 動作設定のJobID {データファイル名またはURL}
引数	なし

注意

-uオプションは、データファイル名を指定した場合に有効です。

-v/--version

機能	UCXSingleのバージョンを表示します。
書式	UCXSingle -v
引数	なし

-z/--zip

機能	Universal Connect/Xサーバーとファイルを送受信する際に、ファイルを圧縮します。
書式	UCXSingle -z 動作設定のJobID {データファイル名またはURL}
引数	なし

参考

オプション-zは、出力ファイル名（-gおよび-G）を指定した場合に有効です。

--help

機能	ヘルプを表示します。
書式	UCXSingle --help
引数	なし

参考

環境変数に UCXSINGLE_OPTSを追加、変数値として通常使うオプションを指定できます。ここで指定されたオプションはコマンドラインで指定されたものより優先度が低くなるため、必要に応じてコマンドラインからオーバーライドできます。
相反する複数のオプションが指定された場合は、後方指定されたものが有効です。
- 例: -l（ログファイル出力）と-n（ログファイル非出力）
  上記の場合、-nが有効となり、ログファイルは出力されません。