SVF Java PRODUCTS API関数リファレンス･マニュアル · はじめにこの度は、SVF Java PRODUCTS（SVF 実行部（Java 版））をお買い上げいただき、誠にあり

はじめに

この度は、SVF Java PRODUCTS（SVF 実行部（Java 版））をお買い上げいただき、誠にあり

がとうございます。

SVF Java PRODUCTS は、PureJava100％の製品であるため、OS 環境に依存しないプリンタ

への出力、PDF ファイル、CSV ファイル、TIFF ファイルなどへの出力が可能となります。高速な

大量帳票印刷の実行、最終加工を前提とした CSV データの書き出し、高精度な PDF ファイ

ル出力に最大の威力を発揮するモジュールとしてご利用いただけます。また、他社製品と連

携することにより、FiBridgeⅡサーバでの帳票データの再利用などを可能にします。

このマニュアルでは、SVF Java PRODUCTS で使用できる API 関数について解説しています。

SVF Java PRODUCTS 製品には出力目的にあわせて以下の製品が用意されています。

SVF Java PRODUCTS

・SVF for Java Print

・SVF for Web/PDF Java Edition

・SVF for Web/CSV Java Edition

・SVF for Web/TIFF Java Edition

・SVF for FiBridgeⅡ/Java Edition

・SVF for FaxPress/Java Edition

・SVF for SignedPDF Server/Java Edition

・SVF for SATO/Java Edition

・SVF for PlainTXT/Java Edition

・SVF for FOG/Java Edition

・SVF for FX-STDOUT/Java Edition

・SVF for PlainTXTⅡ/Java Edition

・SVF for TEC/Java Edition

・SVF for RV/Java Edition

各製品の詳細内容については、該当製品のユーザーズ・マニュアルを参照してください。

SVF 実行部（C 版）をご使用になる場合は、「SVF API 関数（C 版）リファレンス・マニュ

アル」を参照してください。

ii

1 API 関数の呼び出し方法 1

Java を使用する場合 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Java から直接呼び出す場合 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Java コネクトを使用して呼び出す場合 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

ASP、または VB 言語から ASP/COM コネクトを使用しての呼び出し .... . . . . . . . . . . . . . . . 3

C 言語から ASP/COM コネクトを使用しての呼び出し.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 基本的なプログラムの流れ 4

3 API 関数 5

共通関数-1 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

VrInit / VrInitEx .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

VrQuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

VrSetForm .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

VrsOut / VrsOutn .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

VriOut / VriOutn .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

VrlOut / VrlOutn .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

VrrOut / VrrOutn .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

VrEndPage .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

VrSetQuery .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

VrReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

VrEndRecord .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

VrPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

VrSetPrinter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

VrCondit ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

VrSetPageCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

VrCopy .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

VrSetSpoolFi leName2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

VrAdjustd/VrAdjustm .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

VrAdjustd2/VrAdjustm2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

VrAttribute/VrAttributen .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

VrGetAttribute .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

VrTest .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

VrPaperEject .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

VrSeqOut .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

VrPage .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

VrSetCalcMode .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

VrGetStatus .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

VrOutputQuery .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

iii

共通関数-2（Java コネクト、および ASP/COM コネクト以外） .... . . . . . . . . . . . . . . . . . . . . . . . . . . 51

VrGetFieldCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

VrGetFieldName .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

VrGetFieldType.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

VrGetFieldLength .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

VrGetFieldRepeatCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

VrGetFieldRecordType.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54

VrGetPageRecordCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54

SVF for JavaPrint のみで使用できる関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

VrSetTray .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

VrSetDuplex .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

VrSetMachineKind .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

VrSetOutputBin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

VrSetStaple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

VrSetSort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

VrSetPunch .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68

SVF for Web / PDF JavaEdition のみで使用できる関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

VrSetSpoolFi leStream .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

VrComout(“/{SECU n}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

VrComout(“/{PSWD Password}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72

VrComout(“/{SECUPSWD Password}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

VrComout(“/{PERM n}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

VrComout(“/{EXCL xlsname}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76

VrComout(“/{SSHT Sheet}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76

VrComout(“/{SDAT gyono,l ineno,data}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

VrComout(“/{CGRP BmpField,ChartSheet}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

VrComout("/{FOUT n}/") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

VrComout("/{DATE DateData}/") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

SVF for Web / CSV JavaEdition のみで使用できる関数.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

VrSetCSVFileName.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

SVF for FaxPress / JavaEdition のみで使用できる関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

VrSendFaxPress .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83

SVF for SignedPDF Server / JavaEdition のみで使用できる関数 .... . . . . . . . . . . . . 85

VrComout(“/{FORM DEF Name=name 各属性・・・}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

VrComout("/{FORM OUT NAME=xxx}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86

VrComout(“/{SIGN OUT NAME=xxx 各属性・・・}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

SVF for Web / Client 使用時の関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

VrComout(“/{SPLM n}/”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89

索引索引-1

1 API 関数の呼び出し方法


Super Visual Formade Java PRODUCTS（以下 SVF Java PRODUCTS）が提供する API

関数について説明します。

SVF Java PRODUCTS を利用して API 関数を呼び出すには、以下の 3 つの方法があります。

• Java から直接、または Java コネクトを使用しての呼び出し

• ASP、または VB 言語から ASP/COM コネクトを使用しての呼び出し

• C 言語から ASP/COM コネクトを使用しての呼び出し

いずれの場合も、文字列は String 形式としてデータの受け渡しをおこなうため、文字列

の最後は Null データである必要があります。

Ver6.3 より全 API の文字列パラメータに対しての Null チェック機能が追加されました。

これにより Null 文字列パラメータを空文字に変換することが可能になります。

Nul l チェック機能は、デフォルトでは「false」に設定されているため、Null 文字列パラメー

タがあった場合でも、空文字への変換はされません。そのため NullPointerException が

発生し、[-4971]エラーが発生します。

Nul l チェック機能を有効にするためには、vfreport.properties ファイルでの設定を以下

のように変更する必要があります。 ReportWriter.Nul lCheck=true

1

SVF Java PRODUCTS API 関数リファレンス・マニュアル

Java を使用する場合

Java を使用して API 関数を呼び出すには、Java から直接、または Java コネクトを使用す

る方法があります。ここでは、その 2 つの呼び出し方法についての説明をします。

Java から直接呼び出す場合･･･････････････････････････････････････････････

クラスライブラリは、jar 形式のアーカイブファイルとして提供されます。

ライブラリ名 svf.jar

動作環境 JDK1.3

アプリケーション svf.jar に含まれる jp.co.fit.vfreport.Vrw32 クラス

Vrs32 を instance 化することにより実行が可能になります。

Class の import は、以下のように指定します。

import jp.co.fit.vfreport.*;

または

import jp.co.fit.vfreport.Vrw32;

インスタンスを作成する際は、以下の形で作成をおこないます。

Vrw32 svf = new Vrw32();

「svf」は Java プログラム内での任意の変数名ですので、ユニークな名前に変更することが

可能です。

Java コネクトを使用して呼び出す場合････････････････････････････････････

クラスライブラリは、jar 形式のアーカイブファイルとして提供されます。

ライブラリ名 svfrcl ient.jar

動作環境 JDK1.3

アプリケーション svfrcl ient.jar に含まれる jp.co.fit.vfreport.SvfrClient クラス

svfrcl ient.jar を使用して SVF Java PRODUCTS の svf.jar へ接続して実行をおこないま

す。SvfrClient で接続を instance 化することにより実行が可能になります。

Class の import は、以下のように指定します。

import jp.co.fit.vfreport.SvfrClient;

インスタンスを作成する際は、以下の形で作成をおこないます。

SvfrClient svf = new SvfrClient(hostName);

「hostName」には SVF Java PRODUCTS 製品群がインストールされているコンピュータの IP

アドレス、またはマシン名を文字列として入力します。SVF Java PRODUCTS がインストール

されているコンピュータでは、SvfrServer が起動されている必要があります。

2


ASP、または VB 言語から ASP/COM コネクトを使用しての呼び出し

COM 形式の dll として提供されます。

ライブラリ名 svfrcl ient.dl l

動作環境 Windows

アプリケーション svfrcl ient.dl l

svfrcl ient.dl l を使用して、SVF Java PRODUCTS の svf.jar へ接続して実行します。

Vfreport.cl ient で接続を Object 化することにより実行が可能になります。

svfrcl ient.dl l をコールできるように宣言文を定義します。ASP/COM コネクト製品内に用意

されている宣言文のサンプルを参照してください。

Object 化は以下のように実行します。

Set svf = CreateObject(“vfreport.client”).VrConnect("hostname")

「hostName」には SVF Java PRODUCTS 製品群がセットアップされているコンピュータの IP

アドレス、またはマシン名を文字列として入力します。

SVF Java PRODUCTS 製品群がセットアップされているコンピュータでは、SvfrServer が起

動されている必要があります。

C 言語から ASP/COM コネクトを使用しての呼び出し

dll として提供されます。

ライブラリ名 svfrcl ient.dl l

動作環境 Windows

svfrcl ient.dl l を使用して、SVF Java PRODUCTS の svf.jar へ接続して実行します。接続を

instance 化することにより実行が可能になります。

svfrcl ient.dl l を利用できるように、#include 文で定義します。ASP/COM コネクト製品内に

svfrcl ient.h が用意されていますので、それを利用してください。

instance 生成と、SVF Java PRODUCTS 製品群がセットアップされているコンピュータとの

接続は、以下のようにおこないます。

HSVFRCLIENT svf;

svf = VrConnect(“hostname”);

「hostName」には SVF Java PRODUCTS 製品群がセットアップされているコンピュータの IP

アドレス、またはマシン名を文字列として入力します。

SVF Java PRODUCTS がセットアップされているコンピュータでは、SvfrServer が起動され

ている必要があります。

3


2 基本的なプログラムの流れ

アプリケーションプログラムは原則として以下のような 3 パターンとなります。使用する様式フ

ァイルおよびクエリーファイルにより使用する API 関数が異なりますので、注意してください。

パターンは以下のような分岐によって３種類となります。

はどのパターンにも必須の関数です。

はパターンごとに必須となる関数です。

クエリーの使用

について

ライブラリの初期化

Vrlnit

フォームでのサブフォーム

とレコードの使用について

抽出条件の指定（任意）

VrCondition

ライブラリの初期化

Vrlnit ライブラリの初期化

Vrlnit

クエリー様式の指定

VrSetQuery

クエリーの開始

VrReport

印刷用紙の指定

VrSetForm（mode4or5）

フィールドデータ出力

Vr?Out

1レコード分出力終了

VrEndRecord



フィールドデータ出力

Vr?Out(n)*注１

1ページ分出力終了

VrEndPage

使用する

使用する

使用しない

使用しない

ライブラリの開放

VrQuit


VrQuit


VrQuit 印刷の実行

VrPrint

印刷の実行

VrPrint



*注 1 様式ファイルで「繰り返し」機能を使用している場合は、かならず VrSetForm の

モードを「1」に設定してください。

また繰り返しオブジェクトへの出力については Vr？Outn 関数を使用してください。

4

3 API 関数

3 API 関数

SVF Java PRODUCTS では、使用されている製品により、利用可能な関数が異なります。

本マニュアルでは、すべての製品において利用可能な関数は「共通関数」として記載していま

す。その他、製品ごとに利用可能な関数は、その製品名ごとに記載しています。

また書式や設定例などについては、使用する言語によって以下のように表記されています。

Java

ASP、および VB 言語

C 言語

共通関数-1

SVF Java PRODUCTS 製品群内のすべての製品において利用可能な関数について説明

します。

VrInit / VrInitEx

機能初期化します。

書式各言語による書式は、以下のとおりとなります。

int instance.VrInit(String Encode);

Long object.VrInit()

Long object.VrInitEx(String Encode)

int VrInit(HSVFRCLIENT instance); int VrInitEx(HSVFRCLIENT instance, char *Encode);

引数 Encode JavaEncode

以下のコードのいずれかから指定をおこないます。

SJIS

MS932

Cp942

Cp942C

Cp943

Cp943C

戻り値 0 成功

負数エラーステータス

5


説明実行を開始する際には、かならず VrInit 関数を実行します。

VrInit 関数で Java 上での Encode を指定することにより、PDF ファイルや

印刷データの出力時の文字エンコードを指定することが可能になります。

文字エンコードを特に指定する必要がない場合は、引数には、何も指定

しないでください。指定がない場合は、Java が自動的に OS 上の Encode

を元にデータの処理をおこないます。

また、 ASP/COM コネクトを使用している場合は、 Encode の指定は

VrInitEx()関数を用いることで可能になります。Encode 指定が特に必要

ない場合には、通常通り VrInit()関数を利用してください。

使用例使用例は、以下のとおりです。

svf.VrInit(); svf.VrInit(“MS932”);

svf.VrInit()

svf.VrInitEx(“Cp943C”)

VrInit(svf); VrInitEx(svf,”SJIS”);

指定できる Encode は、Java 言語で指定されている SJIS、MS932、Cp942、Cp942C、

Cp943、Cp943C のいずれかとなります。大文字・小文字の判別もおこなわれます。

Java 言語上での「SJIS」は、IBM 拡張文字などの特殊文字には対応していません。

このような特殊文字を利用したい場合は、「MS932」や「Cp943C」などを利用してくださ

い。

それぞれの Encode 種類で対応している文字コードについては、Java 言語の仕様などで

公開されていますので、ホームページなどで確認してください。

VrQuit

機能出力を終了し、解放します。


int instance.VrQuit();

Long object.VrQnit()

int VrQuit(HSVFRCLIENT instance);

引数なし

6

3 API 関数

戻り値整数ファイル出力成功

作成したファイルサイズが戻されます。

0 印刷処理成功

印刷処理を実行した場合は、0 が戻されます。


説明出力処理の最後に、かならず VrQuit 関数を実行します。


svf.VrQuit();

svf.VrQuit();

VrQuit(svf);

ファイル出力時と印刷時で戻り値が異なります。エラーハンドリングをおこなう場合には、

マイナス値が戻されたかどうかを確認してください。

他の Super Visual Formade の関数の戻り値がマイナス値だった場合、VrQuit 関数を

発行することで Super Visual Formade で使用しているプロセスを終了することが可能

です。ただし、アクセス違反など Java の Exception が発生した場合、その時点で強制

終了されることがあるため、エラーハンドリングができないことがあります。その場合、プロ

セスが残ってしまうことがあります。Java コネクトや ASP/COM コネクトを利用する場合

は、かならず実行しているプログラムの最後でセッションを切断してください。セッションが

残り、増えつづけることがあると、使用している Web Appl ication Server 側で予期せぬ

エラーが発生することがあります。

VrSetForm

機能印刷する様式ファイルと出力のモードを指定します。


int instance.VrSetForm(String FormName, int Mode);

Long object.VrSetForm(String FormName, int Mode)

int VrSetForm(HSVFRCLIENT instance, Char *FormName, int Mode);

引数 FormName

様式ファイル名

7


Mode 出力モード

0 シーケンシャルモード

1 ランダムモード

4 レポートライターモード（ソートなし）

5 レポートライターモード（ソートあり）

戻り値 0 成功


説明 Super Visual Formade で使用する関数のほとんどは、VrSetForm 関数で

指定された様式ファイルに対して機能します。一度 VrSetForm 関数で様

式ファイルを指定すると、次に様式ファイルを指定するまで有効になります。

様式ファイル名は、基本的にパス名も含めて指定します。

指定可能な 4 種類のモードにより、データ出力時の利用関数が変わります。

どのモードを使用するかは「基本的なプログラムの流れ」を参照してください。

0 シーケンシャルモード

フィールド名を指定せず、設計したフィールド位置の順（左上から

右下）に関数（VrSeqOut）を使用してデータを出力します。扱え

るデータは文字列データに限定されます。基本は Super Visual

Formade 内部で保有するバッファ順に格納されます。上から順

にリピート行であっても優先されません。

4XXX 3XX

4RRR

と様式ファイルで設計した場合

VrSeqOut(“0001”); VrSeqOut(“002”); VrSeqOut(“0003);

の順に出力をおこなうと

0001 002

0003

と出力されます。

1 ランダムモード

フィールド名とそのフィールドに印字するデータを関数

（Vr?Out(n)）を使用して出力します。このモードを使用すると、フ

ィールドの設計位置に関わらずランダムにデータを出力すること

ができます。各様式ファイルのフィールド名を統一して作成して

おくと、様式ファイル名を変更するだけで、1 本のプログラムで多

数の様式ファイルに対応することが可能です。

扱えるデータは文字列・整数・実数ですが、利用するデータ型

により使用する関数が異なります。

4 レポートライターモード（ソートなし）

クエリーファイルを実行する場合と、サブフォームとレコードが作

成されている様式ファイルを使用する場合に設定します。

5 レポートライターモード（ソートあり）

クエリーファイルを実行する場合と、サブフォームとレコードが作

成されている様式ファイルを使用する場合に設定します。このモ

ードを使用した時には、様式ファイル上で指定したフィールドのキ

ー順に従って Super Visual Formade が内部的にデータのソート

をおこないます。

8

3 API 関数

使用例様式ファイル「sample.frm」を使用して、モード 5 で出力します。

svf.VrSetForm(“c:¥¥frm¥¥sample.frm”, 5);

svf.VrSetForm(“c:¥frm¥sample.frm”, 5)

VrSetForm(svf, “c:¥¥frm¥¥sample.frm”, 5);

出力モードが「0」または「1」の場合、フォーム名、フィールド名の文字の最終桁と Null 文

字の間のスペースは無視されます。出力モードが「4」または「5」の場合には無視されず

データとして送られます。これによりエラーステータス[-30]がこの関数の戻り値として返

され、「様式ファイルが見つからない」という状態になることがあります。

関数使用サンプル

1 度の実行で複数の様式ファイルを利用して出力をおこなう

（Java での実行で 1 つの PDF ファイルに複数の様式ファイルを利用する）

svf.VrInit();

svf.VrSetPrinter(“”, “PDF”);

svf.VrSetSpoolFileName2(“c:¥¥pdf¥¥sample.pdf”);

svf.VrSetForm(“sample1.frm”, 1); ←1 つめの様式ファイルをランダムモードで指定

svf.VrsOut(“name”, “Hiroyuki Kobayashi”);

svf.VrEndPage(); ← ＊1

svf.VrSetForm(“sample2.frm”, 5); ←2 つめの様式ファイルをレポートライターモードで指定

svf.VrsOut(“shohin_name”, “SVF for Web / PDF JavaEdition”);

svf.VrlOut(“su”, 1);

svf.VrEndRecord();

svf.VrPrint(); ← ＊2

svf.VrSetForm(“sample3.frm”, 1); ←3 つめの様式ファイルをランダムモードで指定

svf.VrsOut(“end”, “data-end”);

svf.VrEndPage(); ← ＊1

svf.VrQuit();

＊1 ランダムモード・シーケンシャルモードの場合には、改ページ時、およびすべてのデータ出力終了時に、こ

の関数を呼び出す必要があります。

＊2 レポートライターモードの場合には、すべてのデータ出力終了時に、かならずこの関数を呼び出す必要

があります。

9


VrsOut / VrsOutn

機能文字型データ、またはイメージファイル名を出力します。


int instance.VrsOut(String Field_Name, String data); int instance.VrsOutn(String Field_Name, int gyo, String data);

Long object.VrsOut(String Field_Name, String data)

Long object.VrsOutn(String Field_Name, int gyo, String data)

int VrsOut(HSVFRCLIENT instance, Char *Field_Name, Char *data); int VrsOutn(HSVFRCLIENT instance, Char *Field_Name, int gyo, Char *data);

引数 Field_Name

フィールド名

gyo 繰り返しフィールドの繰り返し番号

data 文字型データ、または、イメージファイル名

戻り値 0 成功


説明文字型データをフィールドに渡します。また、ビットマップフィールドに画像

データファイル名（パス指定付き）を渡します。

様式ファイル設計時に「繰り返し」機能を使用して作成したフィールドに

は VrsOutn 関数を使用して、何行目の繰り返しフィールドに対してデータ

を渡すかを行番号で指定します。繰り返しフィールドの行数は「1」が初期

値となります。この場合、繰り返し数以上のデータを渡す場合には、フォー

ム設計上の[ページの基本設定]ダイアログボックスで[自動改ページ]を

[する]に指定すると、Super Visual Formade 内部で自動的にあふれた行

を次ページに渡します。

文字列の最終桁は Null 文字を（00h）を使用します。Null 文字がないと、

印刷処理が正常におこなわれません。Java 言語では特に Null 文字を意

識する必要はありません。

使用例 ① [会社名]フィールドに「ウイングアーク株式会社」というデータを渡します。

svf.VrsOut(“会社名”,”ウイングアーク株式会社”);

svf.VrsOut(“会社名”,”ウイングアーク株式会社”)

VrsOut(svf, “会社名”, “ウイングアーク株式会社”);

10

3 API 関数

② [品名]繰り返しフィールドの 1 行目に「Super Visual Formade」というデー

タを渡します。

svf.VrsOutn(“品名”, 1, “Super Visual Formade”);

svf.VrsOutn(“品名”, 1, “Super Visual Formade”)

VrsOutn(svf,”品名”,1,”Super Visual Formade”);

③ [画像ロゴ]フィールドに「WingArc.bmp」を出力します。

svf.VrsOut(“画像ロゴ”, “c:¥¥image¥¥WingArc.bmp”);

svf.VrsOut(“画像ロゴ”, “c:¥image¥WingArc.bmp”)

VrsOut(svf,”画像ロゴ”, “c:¥¥image¥¥WingArc.bmp”);

SVF Java PRODUCTS では、出力する制御コードにより貼りつけられる画像ファイルの種

類が異なります。各制御コードに対応している画像ファイルについては各 SVF Java

PRODUCTS 製品の環境設定にある制御コード部分を参照してください。

実行時の SVF Java PRODUCTS のデバッグで、「Nul lPointerException」が発生してい

る場合、データとして出力されている文字列の最後が Null 文字になっていない可能性

があります。その場合は、データを確認してください。

VriOut / VriOutn

機能 32 ビット型整数のデータを出力します。


int VriOut(String Field_Name, int data); int VriOutn(String Field_Name, int gyo, int data);

Long object.VriOut(String Field_Name, int data)

Long object.VriOutn(String Field_Name, int gyo, int data)

int VriOut(HSVFRCLIENT instance, Char *Field_Name, int data); int VriOutn(HSVFRCLIENT instance, Char *Field_Name, int gyo, int data);

11


引数 Field_Name

フィールド名

gyo 行番号

data 数値型データ

戻り値 0 成功


説明 32 ビット型整数データをフィールドに渡します。ゼロサプレスやカンマ編集

などは帳票設計時に設定した編集書式に従っておこないます。様式ファ

イル設計時に「繰り返し」機能を利用して作成したフィールドには

VriOutn 関数を使用して何行目の繰り返しフィールドに対してデータを渡

すかを行番号で指定します。

繰り返しフィールドの行数は「1」が初期値となります。

この場合、繰り返し数以上のデータを渡す場合にはフォーム設計上の[ペ

ージの基本設定]ダイアログボックスで[自動改ページ]を[する]に指定す

ると、Super Visual Formade 内部で自動的にあふれた行を次ページに渡

します。

使用例 ① [数量]フィールドに整数データ「100」を渡します。

svf.VriOut(“数量”, 100);

svf.VriOut(“数量”, 100)

VriOut(svf, “数量”, 100);

② 繰り返し[単価]フィールドの 1 行目に整数データ「700000」を渡します。

svf.VriOutn(“単価”, 1, 700000);

svf.VriOutn(“単価”, 1, 700000)

VriOutn(svf, “数量”, 1, 700000);

データとして渡される整数・実数のバイト数が 14 バイト以上になると、渡されたデータに

+1 されたデータとなり出力される場合があります。このような現象が発生した場合には、

まず「多倍精度十進浮動小数点型演算」を有効にします。その後 VrsOut/VrsOutn

関数を利用して文字型としてデータを渡す必要があります。「多倍精度十進浮動小数

点型演算」を有効にするには VrSetCalcMode 関数を利用するか、vfreport.properties

内で設定を有効にする必要があります。詳しくは p.47 の VrSetCalcMode 関数の説明

を参照してください。

12

3 API 関数

VrlOut / VrlOutn

機能 64 ビット型整数のデータを出力します。


int instance.VrlOut(String Field_Name, long data); int instance.VrlOutn(String Field_Name, int gyo, long data);

Long object.VrlOut(String Field_Name, long data) Long object.VrlOutn(String Field_Name, int gyo, long data)

int VrlOut(HSVFRCLIENT instance, Char *Field_Name, long data); int VrlOutn(HSVFRCLIENT instance, Char *Field_Name, int gyo, long data);

引数 Field_Name

フィールド名

gyo 繰り返しフィールドの繰り返し番号

data データ

戻り値 0 成功


説明 64 ビット型整数データをフィールド名に渡します。

ゼロサプレスやカンマ編集などは設計時に設定した書式に従っておこな

います。様式ファイル設計時に「繰り返し」機能を使用して作成したフィー

ルドには VrlOutn 関数を使用して、何行目の繰り返しフィールドに対して

データを渡すかを行番号で指定します。繰り返しフィールドの行数は「1」

が初期値となります。


ージの基本設定]ダイアログボックスで「自動改ページ」を[する]に指定し

ておくと、Super Visual Formade 内部で自動的にあふれた行を次ページ

に渡します。

使用例 ① [数量]フィールドに整数データ「100」を渡します。

svf.VrlOut(“数量”, 100);

svf.VrlOut(“数量”, 100)

VrlOut(svf, “数量”, 100);

13


② [単価]繰り返しフィールドの 1 行目に整数データ「700000」を渡します。

svf.VrlOutn(“単価”, 1, 700000);

svf.VrlOutn(“単価”, 1, 700000)

VrlOutn(svf, “単価”, 1, 700000);






内で設定を有効にする必要があります。詳しくは p.47「VrSetCalcMode」関数の説明を

参照してください。

VrrOut / VrrOutn

機能実数のデータを出力します。


int instance.VrrOut(String Field_Name, Double data); int instance.VrrOutn(String Field_Name, int gyo, Double data);

Long object.VrrOut(String Field_Name, Double data) Long object.VrrOutn(String Field_Name, int gyo, Double data)

int VrrOut(HSVFRCLIENT instance, Char *Field_Name, double data); int VrrOut(HSVFRCLIENT instance, Char *Field_Name, int gyo, double data);

引数 Field_Name

フィールド名

gyo 行番号

data データ

戻り値 0 成功


14

3 API 関数

説明実数データをフィールド名に渡します。

小数点以下の桁数編集などは、設計時に設定した編集書式に従って

おこないます。

様式ファイル設計時に「繰り返し」機能を使用して作成したフィールドに

は VrrOutn 関数を使用して、何行目の繰り返しフィールドに対してデータ

を渡すかを行番号で指定します。繰り返しフィールドの行数は「1」が初期

値となります。


ージの基本設定]ダイアログボックスで[自動改ページ]を[する]に指定し

ておくと、Super Visual Formade 内部で自動的にあふれた行を次ページ

に渡します。

使用例 ① [数量]フィールドに実数データ「100.00」を渡します。

svf.VrrOut(“数量”, 100.00);

svf.VrrOut(“数量”, 100.00)

VrrOut(svf, “数量”, 100.00);

② 繰り返し[単価]フィールドの 1 行目に「70.50」を渡します。

svf.VrrOutn(“単価”, 1, 70.50);

svf.VrrOutn(“単価”, 1, 70.50)

VrrOutn(svf, “単価”, 1, 70.50);






内で設定を有効にする必要があります。詳しくは p.47「VrSetCalcMode」関数の説明を


15


VrEndPage

機能出力したデータの印刷を開始します。


int instance.VrEndPage();

Long object.VrEndPage()

int VrEndPage(HSVFRCLIENT instance);

引数なし

戻り値 0 成功


説明 1 ページ分のデータ出力が終了したら、VrEndPage 関数を実行し印刷を

開始させます。VrEndPage 関数は VrSetForm 関数のモードが「1」の場

合に有効となります。

また、シーケンシャルモード（VrSetForm のモードが「0」）の場合には、帳票

設計上の最後のフィールドにデータが入った時点で、自動的に

VrEndPage 関数が出力されます。


svf.VrEndPage();

svf.VrEndPage()

VrEndPage(svf);

VrEndPage は、VrSetForm のモードが「4」か「5」の場合には有効になりません。発行さ

れた場合は、常に「0」が戻され正常終了となりますが、改ページなどの処理はおこなわ

れません。

16

3 API 関数

VrSetQuery

機能クエリーファイルを指定します。


int instance.VrSetQuery(String con, String Query_File, int mode);

Long object.VrSetQuery(String con, String Query_File, int mode)

int VrSetQuery(HSVFRCLIENT instance,Char *con,Char *Query_File, int mode);

引数 con データベースへ接続する時の接続文字列です。

通常はユーザ名とパスワードを指定します。

Query_File

クエリー様式ファイル名を指定します。

mode 実行モードとして常に「0」を指定します。

戻り値 0 成功


説明アプリケーションからクエリーファイルの実行をおこないます。関数実行の

順番に関しては p.4「基本的なプログラムの流れ」を参照してください。

使用例ユーザ名：admin、パスワード：password でデータベースへログインし、

c:\WingArc 内のクエリーファイル「sample.vrq」を実行します。

svf.VrSetQuery(“UID=admin;PWD=password”, “c:¥¥WingArc¥sample.vrq”, 0);

svf.VrSetQuery(“UID=admin;PWD=password”, “c:¥WingArc¥sample.vrq”, 0)

VrSetQuery(svf,”UID=admin;PWD=password”, “c:¥¥WingArc¥sample.vrq”, 0);

17


18

SVF Java PRODUCTS 内には、ODBC ドライバや JDBC ドライバは含まれていません。

JDBC ドライバ経由で ODBC ドライバを使用する際には、JDBC ドライバの仕様による制

約でファイル DSN は使用できません。

Oracle 社の JDBC ドライバは OCI モードと Thin モードの両方に対応しています。クエリー

設計時は OCI モード（ORCL/ORA81）でのクエリー作成となりますが、設定ファイルなど

を変更することにより Thin 接続も可能になります。

設定方法は以下の補足説明を参照してください。

IBM 社の JDBC ドライバを使用することにより、DB2 と接続することができます。クエリー

設計時は ODBC ドライバ経由でのクエリー作成となりますが、設定ファイルなどを変更す

ることにより、JDBC ドライバを経由してのネイティブ接続も可能になります。

設定方法は以下の補足説明を参照してください。

JDBC ドライバを利用する場合は、Java の環境変数（CLASSPATH 指定）、または起動

オプション（-cp）を設定し、そのドライバをロードできるようにする必要があります。

設定方法は Web Appl ication Server により異なります。使用する Web Appl ication

Server のマニュアルを参照してください。

補足説明

≪OracleDB 利用時に Thin 接続を利用する方法≫

1 クエリーファイル作成時に「データベースドライバ」選択画面で、「ドライバ名」をかなら

ず「ORCL」、または「ORA81」で作成します。

（SQL*Net7.3、および Oracle8 を利用している場合は、「ORCL」を、Oracle8i を利用し

ている場合は、「ORA81」を選択します。）

2 vfreport.properties をテキストエディタで開き、以下のように変更します。

変更前 Query.Drivers=ODBC=ODBC,ORCL=ORCL.OCI8,ORA81=ORCL.OCI8,･･･

↓ ↓

変更後 Query.Drivers=ODBC=ODBC,ORCL=ORCL.THIN,ORA81=ORCL.THIN,･･･

3 VrSetQuery の呼び出しを、以下のように変更します。。

Java svf.VrSetQuery(“DBQ=xxx;UID=xxx;PWD=xxx;SID=xxx” , “xxx.vrq” , 0);

ASP・VB svf.VrSetQuery(“DBQ=xxx;UID=xxx;PWD=xxx;SID=xxx “ , “xxx.vrq” , 0)

C VrSetQuery(svf,”DBQ=xxx;UID=xxx;PWD=xxx;SID=xxx “ , “xxx.vrq” , 0)

DBQ DB サーバのホスト名または IP アドレスを指定します。

UID ユーザ ID を指定します。

PWD パスワードを指定します。

SID コネクト文字列（ネットサービス名）を指定します。

≪OracleDB 利用時に OCI 接続でクエリー設計時と違う DB サーバーへ接続する方法≫

1 クエリーファイル作成時に「データベースドライバ」選択画面で「ドライバ名」をかならず

「ORCL」、または「ORA81」で作成します。

SQL*Net7.3、および Oracle8 を利用している場合は、「ORCL」を、Oracle8i を利用し

ている場合は、「ORA81」を選択します。

2 VrSetQuery の呼び出しを、以下のように変更します。

Java svf.VrSetQuery(“UID=xxx;PWD=xxx;DBQ=xxx” , “xxx.vrq” , 0);

ASP・VB svf.VrSetQuery(“UID=xxx;PWD=xxx;DBQ=xxx” , “xxx.vrq” , 0)

C VrSetQuery(svf, “UID=xxx;PWD=xxx;DBQ=xxx” , “xxx.vrq” , 0);



DBQ DB サーバのホスト名または IP アドレスを指定します。

3 API 関数

≪DB2 利用時に JDBC 経由でクエリー接続する方法）

1 クエリーファイル作成時に「データベースドライバ」選択画面で「ドライバ名」をかならず

「ODBC」で作成します。


Java svf.VrSetQuery(“$KIND=DB2;UID=xxx;PWD=xxx” , “xxx.vrq” , 0);

ASP・VB svf.VrSetQuery(“$KIND=DB2;UID=xxx;PWD=xxx” , “xxx.vrq” , 0)

C VrSetQuery(svf, “$KIND=DB2;UID=xxx;PWD=xxx” , “xxx.vrq” , 0);

$KIND クエリー設計時に「ODBC」接続で作成したものを、JDBC-DB2 接

続に変更します。



≪WebSphere でコネクションプール機能を利用してクエリー接続する方法≫


Java

svf.VrSetQuery(“$KIND=xxx;DBALIAS=xxx;UID=xxx;PWD=xxx” ,”xxx.vrq” ,0);

ASP・VB

svf.VrSetQuery(“$KIND=xxx;DBALIAS=xxxUID=xxx;PWD=xxx” ,”xxx.vrq” ,0)

C

VrSetQuery(svf,”$KIND=xxx;DBALIAS=xxx;UID=xxx;PWD=xxx” ,”xxx.vrq” ,0);

＄KIND WebSphere Appl ication Server（以下 WAS）のバージョンにあわせ

て接続の種類を指定します。

$KIND=WAS WAS3.0 の場合

$KIND=WAS3 WAS3.0 の場合

$KIND=WAS4 WAS4.0 の場合

WAS のバージョンが 3.0 の場合は、「WAS」「WAS3」のどちらの記

述も可能です。

DBALIAS

データソース名を指定します。

VrReport

機能クエリーの実行をおこないます。


int instance.VrReport();

Long object.VrReport()

int VrReport(HSVFRCLIENT instance);

19


引数なし

戻り値 0 成功


説明 VrSetQuery 関数で指定したクエリーファイルを実行します。VrCondition

関数を利用し抽出条件を指定している場合は、その条件に従って実行

し、VrSetForm 関数で指定した様式ファイルに出力をおこないます。


svf.VrReport();

svf.VrReport()

VrReport(svf);

VrEndRecord

機能明細レコード 1 行分にデータを出力し終えたことを SVF に指示します。


int instance.VrEndRecord();

Long object.VrEndRecord()

int VrEndRecord(HSVFRCLIENT instance);

引数なし

戻り値 0 成功


説明明細レコード 1 行分のデータ出力を終えるごとに発行します。明細レコー

ドを複数設計している場合には、1 回の VrEndRecord 関数ですべての明

細レコードを設計順に印刷します。

この関数は VrSetForm 関数のモードが「4」または「5」の場合に有効にな

ります。

VrSetForm 関数のモードが「0」または「1」の場合には、無効となり正常

終了として戻り値「0」を返します。

20

3 API 関数


svf.VrEndRecord();

svf.VrEndRecord()

VrEndRecord(svf);

レコード内に設計されているフィールドに 1 つもデータがない場合に、空行を印刷しないよ

うに設定するには、様式ファイル設計上の［レコードの設定］ダイアログボックスの[全フィ

ールドが初期値の時、印刷しない]欄にチェックをつけます。詳細については「Super

Visual Formade ユーザーズ・マニュアル設計編」の「第 4 章フォーム設計編詳細機

能」－「書式メニュー」の「レコード」を参照してください。

VrPrint

機能レポートライターモードで指定した帳票の印刷を実行します。


int instance.VrPrint();

Long object.VrPrint()

int VrPrint(HSVFRCLIENT instance);

引数なし

戻り値 0 成功


説明 VrPrint 関数は、サブフォームとレコードが設計されている様式ファイルに

印刷する場合と、クエリーを実行する場合の印刷実行関数です。この関

数は明示的に発行されなくても、VrQuit 関数が発行された時点で内部

的に実行されます。しかし、VrQuit 関数は、発行されると印刷の実行と同

時に解放の処理もおこなってしまうため、複数フォームを利用して 1 つの

出力文書としたい場合や総ページ数を取得する場合には、VrPrint 関数

を利用して明示的に出力の終了をおこなう必要があります。

21



svf.VrPrint();

svf.VrPrint()

VrPrint(svf);

VrPrint 関数を呼び出す必要がある具体的なケースは、以下の 2 つです。

① 印刷終了後、解放をおこなう前に呼び出す関数がある場合

[関数例]

VrGetManageNum()

VrGetAttribute()

② 1 度の VrInit～VrQuit の間に、複数の様式ファイルを利用し、かつその様式ファイ

ルがレポートライター様式かクエリーファイルを利用している場合。

VrSetPrinter

機能出力するプリンタを指定します。


int instance.VrSetPrinter(String PDL, String Printer);

Long object.VrSetPrinter(String PDL, String Printer)

int VrSetPrinter(HSVFRCLIENT instance, Char *PDL, Char *Printer);

引数 PDL プリンタ制御コード

Printer プリンタ名

戻り値 0 成功


説明出力するプリンタ名の指定をおこないます。SVF Java PRODUCTS 製品

群を利用して実行をおこなう場合、第二引数[Printer]で指定されるプリ

ンタ内部で PDL（プリンタ記述言語）を持っているため、第一引数[PDL]

は特に明示的に指定をおこなう必要はありません。第二引数[Printer]は、

SVF Java PRODUCTS の環境設定アプレットであらかじめ作成されてい

るプリンタ名を指定します。プリンタの作成方法は利用している SVF

Java PRODUCTS のユーザーズ・マニュアルを参照してください。

22

3 API 関数

使用例［PDF］という名前のプリンタに出力をおこないます。


svf.VrSetPrinter(“”, “PDF”)

VrSetPrinter(svf, “”, “PDF”);

SVF for Web / PDF JavaEdition Ver1.4 以前の製品を利用している場合は、第一引

数、および第二引数ともに”PDF”という文字列のみが指定可能になります。

Super Visual Formade 実行部や Report Director など C 版の製品を利用している場

合は、VrSetPrinter 関数の指定方法が異なります。「Super Visual Formade API 関数

（C 版）リファレンス・マニュアル」を参照してください。

VrSetPrinter 関数は VrInit 関数の直後に利用してください。

その他の関数を利用した後に実行をおこなうと、VrInit 関数と VrSetPrinter 関数の間

に呼び出された関数はクリアされます。関数の使用順については、次の「関数使用順」

欄を参照してください。

関数使用順

svf.VrInit();


svf.VrSetForm(“sample.frm”, 5);

svf.VrSetSpooleFile2(“sample.pdf”);

svf.VrsOut(“field”, “data”);

svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

VrCondition

機能クエリーの抽出条件を指

書式各言語による書式は、以

int instance.VrConditio

Long object.VrConditio

int VrCondition(HSVFR

この部分は基本的なプログラムの流れを


定します。

下のとおりとなります。

n(String pic, int mode);

n(String pic, int mode);

CLIENT instance, Char *pic, int mode);

23


引数 pic 抽出条件を指定します。

mode モード

0 条件式を設計時に指定した条件式と置き換えます。

設計時の条件をクリアする場合には””を指定します。

1 条件式を設計時の条件時に AND で追加します。

3 VrCondition 関数で設定した条件をクリアし、設計時の

条件式に戻します。

4 クエリー設計部で設定した変数に、値を代入します。

5 VrCondition のモード 4 で指定した抽出条件をすべてク

リアし、設計時の状態に戻します。

6 実行時のテーブル名を変更します。

”［設計時のテーブル名]=[実行時のテーブル名]”

戻り値 0 成功


説明 VrSetQuery 関数以降、VrReport 関数以前にこの関数を発行する必要

があります。

使用例モード 0 を使用して設計時の条件をクリアします。

svf.VrCondition(“”, 0);

svf.VrCondition(“”, 0)

VrCondition(svf, “”, 0);

クエリー設計時に変数を利用している場合、VrCondition 関数を使わずに実行するとエ

ラーが発生します。変数を使用している場合には、かならず VrCondition 関数のモード 4

を利用して値の代入をおこなってください。

複数の抽出条件を指定したい場合、VrCondition 関数を複数発行するのではなく、1

回の VrCondition 関数内で”AND”や”OR”の連結子を利用して実行してください。

モード 6 を使用する場合の注意点

・同種のデータ構造を持つテーブルのみ指定可能になります。

また、指定するテーブル名と、クエリーファイル内の［DATABASE］セクションの DBn に

記述されているテーブル名とが、完全に一致している必要があります。一致していない

場合には、実行は受けつけられずエラーとなります。

・クエリーファイル内では、接続 DB ドライバが推奨する引用符をドライバから取得するた

め、接続ドライバによりクエリーファイル内で管理する引用符が異なります。一度クエリ

ーファイルをテキストエディタで開き、［DATABASE］セクションの DBｎに記述されてい

るテーブルを確認してから指定をおこなってください。ただし、クエリーファイル自体をテ

キストエディタ上で修正し、実行をおこなうことは、サポートの範囲対象外の事項となり

ます。クエリーファイルをテキストエディタで開くことは、あくまでも確認する場合のみに

してください。

・クエリーファイルが DB1=”明細”となっている場合には、両端の二重引用符を取り除い

た［`'明細'］をテーブル名として指定します。

24

3 API 関数

関数使用順 1（条件式を設計時に設定した条件式と置き換える場合）

svf.VrInit();



svf.VrSetSpoolFile2(“sample.pdf”);

svf.VrSetQuery(“UID=WingArc;PWD=WingArc”, “sample.vrq”);

svf.VrCondition(“[code]Between 001 AND 010”, 0);

svf.VrReport();

svf.VrPrint();

svf.VrQuit();

関数使用順 2（設計している変数に値を代入する場合）

設計時に指定した条件式:BETWEEN [9| start_code] AND [9| end_code]

svf.VrInit();

svf.VrSetPrinter(“”, “EMF”);

svf.VrSetForm(“sample.pdf”, 5);

svf.VrSetSpoolFileName2(“ sample.pdf”);

svf.VrSetQuery(“UID=WingArc;PWD=WingArc”, “sample.vrq”);

svf.VrCondition(“[9| start_code] = 001”, 4);

svf.VrCondition(“[9| end_code] = 010”, 4);

svf.VrReport();

svf.VrPrint();

svf.VrQuit();

VrSetPageCount

機能設計関数の PAGE()関数の初期値と加算値を設定します。


int instance.VrSetPageCount(int no, int add);

Long object.VrSetPageCount(int no, ind add)

int VrSetPageCount(HSVFRCLIENT instance, int no, int add);

引数 no PAGE の初期値

add PAGE の加算値

25


戻り値 0 成功


説明設計関数の PAGE()関数は、VrSetPageCount 関数で指定した値によっ

て連番を取得します。VrSetPageCount 関数を利用しない場合は、

VrInit 関数、VrSetForm 関数が実行されると初期値、加算値が「1」にセ

ットされます。

使用例 PAGE()関数に対して、ページ番号の初期値を「5」にし、加算値を「1」と

指定します。

svf.VrSetPageCount(5, 1);

svf.VrSetPageCount(5, 1)

VrSetPageCount(svf, 5, 1);

VrSetPageCount 関数は VrSetForm 関数とページの終了関数（VrEndPage）の間で

設定します。基本的には VrSetForm 関数の次に発行するようにしてください。

関数使用順

svf.VrInit();





svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

関数

（2 つの帳票を使用し

StringBuffer buf = new StringBuffer();

svf.VrInit();


svf.VrSetForm(“sample1.frm”, 5);


svf.VrEndRecord();

26



使用順：応用

、ページを連番で取得する場合）

3 API 関数

svf.VrPrint();

svf.VrGetAttribute(“TotalPageCount”, buf);← 1 つめの帳票の総ページを取得

String page_no1 = attr.toString();← StringBuffer から String 変換

int page_cnt1 = Integer.valueOf(page_no1).intValue();← String から int 変換

page_cnt1 = page_cnt1 + 1;← 次の帳票の初期値指定のために取得したページ数に+1

svf.VrSetForm(“sample2.frm”, 5);

svf.VrSetPageCount(page_cnt1, 1);← +1 した値を初期値として指定


svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

VrGetAttribute 関数を利用して総ページを取得するには、VrSetForm のモードが「4」

か「5」である必要があります。詳しくは VrGetAttribute 関数を参照してください。

VrCopy

機能印刷部数を指定します。


int instance.VrCopy(int n);

Long object.VrCopy(int n)

int VrCopy(HSVFRCLIENT instance, int n);

引数 n 部数

戻り値 0 成功


説明同一ページを指定した部数出力します。あらたに VrCopy 関数を呼び出

して部数をセットするか、または、あらたに様式ファイルを指定するまで、

設定した部数を出力します。この関数を利用しない場合は、設計時に指

定した部数に従って出力をおこないます。

設計時に指定した部数と、VrCopy 関数を利用して指定した部数が異

なる場合には、VrCopy 関数で指定した部数が有効になります。

27


使用例印刷部数を「3」に指定します。

svf.VrCopy(3);

svf.VrCopy(3)

VrCopy(svf, 3);

印刷部数に「1」を指定している、または、VrCopy 関数を使用せず、様式ファイルの部

数指定も「1」に指定しているにも関わらず同じページが何枚も出力されてしまう場合に

は、以下の確認をします。

・［ESC／PAGE や RPDL になどの制御コードで出力している場合］

プリンタ実機のパネルにてステータスシートを出力し、「コピー枚数」や「印刷部数」とい

うような項目を確認します。複数枚設定がされていると、指定されている枚数分出力

されます。

・リンクフォームの機能を利用している場合には、製品内で自動的に VrSetForm 関数

を呼び出しています。このため、VrCopy 関数で指定された部数がリンク先のフォームに

出力する時に有効になりません。リンクフォーム機能を利用して部数を指定したい場

合は、フォーム設計時に指定をおこなってください。リンクフォーム機能を利用せずに、プ

ログラム側で制御をおこなうこともできます。

関数使用順

svf.VrInit();

svf.VrSetPrinter(“”, “printer”);



svf.VrCopy(3);


svf.VrEndPage();



svf.VrQuit();

* VrCopy 関数は VrSetForm 関数と VrEndPage 関数の間で実行します。

28

3 API 関数

VrSetDocName2

機能 1. Report Director Enterprise へスプーラする文書名を指定をします。

2. SVF for PDF/Java Edition で作成された PDF 文書のプロパティでの

タイトルを指定します。


int instance.VrSetDocName2(String DocName);

Long object.VrSetDocName2(String DocName);

int VrSetDocName2(HSVFRCLIENT instance, Char DocName);

引数 DocName

戻り値 0 成功


説明 Report Director Enterprise にスプールする際の文書名を指定します。

この API 関数を使用し文書名を指定しておくと、 Report Director

Enterprise ユーティリティ画面でどのような帳票がスプールされているか

がわかりやすくなります。

SVF for PDF/Java Edition で作成された PDF 文書のプロパティでのタ

イトルを指定します。

使用例スプールする際の文書名を指定します。

svf.VrSetDocName2("仕訳日記帳");

svf.VrSetDocName2("仕訳日記帳")

VrSetDocName2(svf,"仕訳日記帳")

29


VrSetSpoolFileName2

機能ファイル出力をおこなう場合に、作成するファイル名とその作成場所を指

定します。


int instance.VrSetSpoolFileName2(String FileName);

Long object.VrSetSpoolFileName2(String FileName);

int VrSetSpooleFileName2(HSVFRCLIENT instance Char *FileName);

引数 Fi leName ファイル名（フルパス指定。最大 255 バイト）

戻り値 0 成功


説明作成するファイル名とその作成場所を指定します。

VrSetSpoolFi leName2 関数を使用しない場合は、環境設定アプレットで

指定されているプリンタの［出力ディレクトリ］欄で指定されているパスへ

ファイルが作成されます。

使用例 /home/svf の下に「sample.pdf」を作成します。

svf.VrSetSpoolFileName2(“/home/svf/sample.pdf”);


VrSetSpoolFileName2(svf, “/home/svf/sample.pdf”);

作成するファイルがすでに存在している場合には、通常は上書きで新しいファイルを作

成します。ただし、既存のファイルがオープンされている場合や、何らかの理由により使

用されている場合には、上書きすることができません。そのため、作成するファイル名とし

て、つねに動的に変更されるような名前を指定してください。

ファイル名に日付や、時間等をいれて保存すると、上書きなどの処理が発生する可能

性が低くなります。日付や時間の取得方法は、利用している開発言語によって異なる

ため、使用しているアプリケーションで確認してください。

Java コネクトや ASP/COM コネクトから実行する場合は、作成されたファイルを呼び出し

元であるアプリケーションサーバに戻します。このため、ファイルの保存先は、アプリケーシ

ョンサーバからのパスを指定する必要があります。この時、様式ファイル名やクエリーファ

イル名の指定は、ファイル生成をおこなう SVF 関連製品がセットアップされているコンピ

ュータから見たパスを指定してください。

30

3 API 関数

関数使用順

svf.VrInit();




svf.VrsOut(“Field”, “data”);

svf.VrEndRecord();

svf.VrPrint();



svf.VrQuit();

VrAdjustd / VrAdjustm

機能印字位置を調整します。


int instance.VrAdjustd(String Form, int x, int y); int instance.VrAdjustm(String Form, int x, int y);

Long object.VrAdjustd(String Form, int x, int y) Long object.VrAdjustm(String Form, int x, int y)

int VrAdjustd(HSVFRCLIENT instance, Char *Form, int x, int y); int VrAdjustm(HSVFRCLIENT instance, Char *Form, int x, int y);

引数 Form 様式ファイル名

x 左右調整値（正=右方向、負=左方向）

y 上下調整値（正=下方向、負=上方向）

調整値の単位はコマンドにより次のように異なります。

VrAdjustd の場合

1/400 ドット（1 ドット=1/400 インチ、約 0.06 ミリ）

VrAdjustm の場合

1/10 ミリ

戻り値 0 成功


説明ドット、またはミリ単位でフォームの印字位置を移動します。フォーム設計

時に印字位置を指定している場合は、その値にこの関数で指定した調

整値が加算（または減算）され、印字位置が決められます。この関数で

指定した調整値は様式ファイルに保存され、以降の印刷はこの調整値

で調整した位置に出力されます。

31


使用例 ① /home/svf/sample.frm の印字位置を左に 40 ドット、下に 20 ドット移動

します。

svf.VrAdjustd(“/home/svf/sample.frm”,-40, 20);


VrAdjustd(svf,”/home/svf/sample.frm”,-40, 20);

② /home/svf/sample.frm の印字位置を左に 4 ミリ、下に 2 ミリ移動します。



VrAdjustd(svf,”/home/svf/sample.frm”,-40, 20);

この関数を一度使用すると様式ファイル内に情報が書きこまれます。一時的な印字位

置の変更をおこなう場合には、VrAdjustd2/VrAdjustm2 関数を利用してください。

VrAdjustd2 / VrAdjustm2

機能印字位置を一時的に調整します。


int instance.VrAdjustd2(String Form, int x, int y); int instance.VrAdjustm2(String Form, int x, int y);

Long object.VrAdjustd2(String Form, int x, int y) Long object.VrAdjustm2(String Form, int x, int y)

int VrAdjustd2(HSVFRCLIENT instance, Char *Form, int x, int y); int VrAdjustm2(HSVFRCLIENT instance, Char *Form, int x, int y);

32

3 API 関数

引数 Form 様式ファイル名

x 左右調整値（正=右方向、負=左方向）

y 上下調整値（正=下方向、負=上方向）

調整値の単位はコマンドにより次のように異なります。

VrAdjustd の場合

1/400 ドット（1 ドット=1/400 インチ、約 0.06 ミリ）

VrAdjustm の場合

1/10 ミリ

戻り値 0 成功


説明ドットまたはミリ単位でフォームの印字位置を移動します。フォーム設計時

に印字位置を指定している場合は、その値にこの関数で指定した調整

値が加算（または減算）され、印字位置が決められます。この関数で指

定した調整値は様式ファイルには保存されず、以降の印刷は様式ファイ

ル内で調整した位置に出力されます。

使用例 ① /home/svf/sample.frm の印字位置を一時的に左に 40 ドット、下に 20

ドット移動します。

svf.VrAdjustd2(“/home/svf/sample.frm”,-40,20);

svf.VrAdjustd2(“/home/svf/sample.frm”,-40,20);

VrAdjustd2(svf,”/home/svf/sample.frm”,-40, 20);

② /home/svf/sample.frm の印字位置を左に 4 ミリ、下に 2 ミリ移動します。

svf.VrAdjustd2(“/home/svf/sample.frm”, -40, 20);

svf.VrAdjustd2(“/home/svf/sample.frm”, -40, 20);

VrAdjustd2(svf, “/home/svf/sample.frm”, -40, 20);

この関数は一時的に印字位置を調整する関数です。恒久的に印字位置を変更する

場合には、VrAdjustd/VrAdjustm 関数を利用してください。

33


VrAttribute / VrAttributen

機能フィールドの属性を一時的に変更します。


int instance.VrAttribute(String Field, String Data); int instance.VrAttributen(String Field,int gyo,String data);

Long object.VrAttribute(String Field, String Data) Long object.VrAttributen(String Field, int gyo, String data)

int VrAttribute(HSVFRCLIENT instance, Char *Field, Char Data); int VrAttributen(HSVFRCLIENT instance, Char *Field, int gyo, Char Data);

引数 Field フィールド名またはレコード名

gyo 行番号

Data 変更データ

戻り値 0 成功


説明指定したフィールドの属性や機能を一時的に変更して印刷します。

VrEndPage 関数が実行される（改ページが発生する）と、設計時の属性

に戻ります。変更する属性の項目名と変更内容を、以下の記述に従って

指定します。

カンマで区切ると一度に複数の項目を指定することが可能です。複数

項目の変更をおこなった場合、いずれかの指定に誤りがあると戻り値に

はエラーステータスが戻されますが、正常な指定の部分に関しては処理

が実行されます。

項目名記述指定内容

開始 X 座標 X 0 以上（ドットで指定）

開始 Y 座標 Y 0 以上（ドットで指定）

全角フォント ZenFont 0:明朝体 1:ゴシック

半角フォント HanFont 0:全角フォントに従う

1:クーリエ

文字サイズ Size 1.0～96.0

34

3 API 関数


桁数※ Keta 1～256

半角／全角 HanZen 0:半角 1:全角

縦倍率 TateBai 0.5,1.0,2.0,3.0,4.0,6.0,8.0

横倍率 YokoBai 0.5,1.0,2.0,3.0,4.0,6.0,8.0

明度 Meido 0:黒 100:白

ボールド Bold 0:しない 1:する

イタリック Ital ic 0:しない 1:する

アウトライン OutLine 0:しない 1:する

シャドウ Shadow 0:しない 1:する

編集スタイル Hensyu 0:無編集 1:右詰め 2:左詰め 3:中央割付

4:均等割付 5:小数点位置固定右詰め

データ型※ DataStyle 0:文字 1:数値

印字方向 Direction 0:横 1:縦

回転 Rotation 0,90,180,270

計算式※ Calc 計算式を記述

編集式※ Edit 編集式を記述

リンクフィールド名※ LinkField リンクするフィールド名を指定

綴りページ指定 Tsuzuri 0:印字しない 1:印字する

入力ロック Lock 0:しない 1:する

アンダーライン UnderLine (X1､X2､X3)

X1:線種

0=実線 1=破線 1 2=破線 2

3=破線 3 4=一点鎖線 5=ニ点鎖線

X2:線幅

1～16 ドット

X3:種類

1=アンダーライン 2=オーバーライン

3=2 重アンダーライン

4=2 重オーバーライン 5=打ち消し線

35



ｓフィールド色 Palette 0～15

パレット番号は、設計部のパレットウインドウで、

0 1 2 3

4 5 6 7

8 9 10 11

12 13 14 15

と割り当てられています。

フィールド背景の色 Paint (X1,X2,X3)

X1=パレット番号

0～15

X2=塗り込みの明度

0～100

X3=塗り込みフラグ 1or2

1=フィールドの範囲の塗り込み

2=フィールドを囲む罫線の範囲の塗り込み

改ページ (SVF) FF 0:しない 1:する

印字(SVF) Print 0:しない 1:する

2:すべてのフィールドが初期値なら印刷しない

バナー自動挿入

(SVF)

BANNER 様式ファイル名

ソート順変更(SVF) ORDER 数値ソート順（+値は昇順、－値は降順）

ASC 昇順（ソート順は変更せずに昇順に設

定）DESC 降順（ソート順は変更せずに降順設

定）NULL 設定を解除し設計時の設定に戻る

レコードの挿入

(SVF)

BLANK レコード名

※の項目については、VrSetForm 関数のモードが 4 または 5 のレポートライターモードでの

使用はできません。

36

3 API 関数

使用例 ① ［会社名］フィールドを「全角フォント=ゴシック、文字サイズ=10.8 ポイント、

縦倍率=3.0」に変更します。

svf.VrAttribute(“会社名”,”ZenFont=1,Size=10.8,TateBai=3.0”);

svf.VrAttribute(“会社名”,”ZenFont=1,Size=10.8,TateBai=3.0”)

VrAttribute(svf, “会社名”,”ZenFont=!,Size=10.8,TateBai=3.0”);

② ［金額］フィールドの計算式を「数量 *単価」、編集式を「FORMAT(金

額,”ZZZ9”)」に変更します。

svf.VrAttribute(“金額”,”Calc=単価*数量,Edit=FORMAT(金額,”ZZZ9”)”);

svf.VrAttribute(“金額”,”Calc=単価*数量,Edit=FORMAT(金額,”ZZZ9”)”)

VrAttribute(svf,”金額”,”Calc=単価*数量,Edit=FORMAT(金額,”ZZZ9”)”);

③ 繰り返しフィールド［品名］の 1 行目をボールドで印刷します。

svf.VrAttribute(“品名”, 1, “Bold=1”);

svf.VrAttribute(“品名”, 1, “Bold=1”)

VrAttribute(svf, “品名”, 1, “Bold=1”);

④ ［会社名］フィールドにアンダーラインを引きます。

svf.VrAttribute(“会社名”, “UnderLine=(0,1,1)”);

svf.VrAttribute(“会社名”, “UnderLine=(0,1,1)”)

VrAttribute(svf, “会社名”, “UnderLine=(0,1,1)”);

37


⑤ 5 枚綴りの 2,3 ページのみ［金額］フィールドを印字し、他のページには印

字しません。

svf.VrAttribute(“金額”, “Tsuzuri=01100”);

svf.VrAttribute(“金額”, “Tsuzuri=01100”)

VrAttribute(svf, “金額”, “Tsuzuri=01100”);

⑥ ［会社名］フィールドの背景色をグレーで印刷します。

svf.VrAttribute(“会社名”, “Paint=(7,90,1)”);

svf.VrAttribute(“会社名”, “Paint=(7,90,1)”)

VrAttribute(svf, “会社名”, “Paint=(7,90,1)”);

1 の場合（フィールドの範囲）

会社名

2 の場合（フィールドを囲む罫線の範囲）

会社名

⑦ ［明細］レコードの中にあるすべてのフィールドが初期値（データがない）場

合には印刷しません。

svf.VrAttribute(“明細”, “Print=2”);

svf.VrAttribute(“明細”, “Print=2”)

VrAttribute(svf, “明細”, “Print=2”);

38

3 API 関数

⑧ ［得意先 chord］フィールドの内容が変化すると改ページをおこないます。

設計上の「フィールドの一括設定」画面の「レポートライター」タブ画面で

の設定よりも優先されます。

svf.VrAttribute(“得意先コード”, “FF=1”);

svf.VrAttribute(“得意先コード”, “FF=1”)

VrAttribute(svf, “得意先コード”, “FF=1”);

⑨ ［金額］フィールドのデータを印刷しません。

svf.VrAttribute(“金額”, “Print=0”);

svf.VrAttribute(“金額”, “Print=0”)

VrAttribute(svf, “金額”, “Print=0”);

⑩ ［売上月］フィールドが変化すると改ページし、/home/svf/banner.frm を

挿入します。

様式名部分に Null（例 BANNER=””）をセットすると設定が解除されます。

svf.VrAttribute(“売上月”,”BANNER=/home/svf/banner.frm”);

svf.VrAttribute(“売上月”,”BANNER=/home/svf/banner.frm”)

VrAttribute(svf,”売上月”, “BANNER=/home/svf/banner.frm”);

⑪ ［売上月］［売上日］の順でソートし、［売上日］は降順に設定します。

ソートは、Null（例 “ORDER=”）をセットすると解除されます。

svf.VrAttribute(“売上月”, “ORDER=1”); svf.VrAttribute(“売上日”, “ORDER=-2”)

svf.VrAttribute(“売上月”, “ORDER=1”);

svf.VrAttribute(“売上日”, “ORDER=-2”);

39


VrAttribute(svf,, “売上月”, “ORDER=1”) VrAttribute(svf, “売上月”, “ORDER=-2”);

⑫ ［得意先］フィールドが変化すると、明細行の次にレコード［YOHAKU］を

印字します。

［ YOHAKU ］レコード内のフィールドにデータを出力する場合は、

VrAttribute 関数を発行する前に Vr?Out 関数を使用しデータを出力し

ます。挿入レコードは、Null（例 “BLANK=”）をセットすると解除されます。

svf.VrAttribute(“得意先”, “BLANK=YOHAKU”);

svf.VrAttribute(“得意先”, “BLANK=YOHAKU”)

VrAttribute(svf, “得意先”, “BLANK=YOHAKU”);

文字修飾の「ボールド」「イタリック」「アウトライン」「シャドウ」「明度（白文字）」に関して

は、プリンタ実機の機能によって使用できない場合があります。指定しても文字修飾が

できない場合は、プリンタ付随のマニュアルで使用可能かどうかを確認してください。

レコードとサブフォームを設計しているフォームの場合に使用できる 6 つの指定は、

VrSetForm 関数の直後に出力します。次回 VrSetForm 関数が実行されるまで有効に

なります。リンクフォーム機能を使用している場合には、内部的に VrSetForm 関数が発

行されるため、リンク先フォームでは VrAttribute 関数でおこなわれた定義は無効になり

ます。

クエリーから実行がおこなわれている場合には、データを発行する Vr?Out 関数と

VrEndRecord 関数を内部的に発行しているため、指定する内容によっては、一番最初

に出力されるレコードにのみ設定が有効になる場合があります。

ソート順の変更機能は、あくまでもデータのソート順の変更をおこなう機能です。そのた

め、キーブレイクによる合計行やヘッダ行の指定をおこなっている場合、またはグループ

集計演算を使用している場合には、昇順／降順の変更のみが可能になります。キーフ

ィールドのソート順序の変更や解除はおこなえません。

カラー対応ではない機種を利用して出力する場合は、Palette や Paint パラメータを指

定しても有効にはなりません。

40

3 API 関数

VrGetAttribute

機能フィールドの属性を取得します。

書式各言語による書式は、以下のとおりとなります。ASPでは使用できません。

instance.VrGetAttribute(String Field, String Komoku, StringBuffer Data);

Long object.VrGetAttribute(String Field, String Komoku, String Data);

int VrGetAttribute(HSVFRCLIENT instance, Char *Field, Char *Komoku, Char *Data);

引数 Field フィールド名

Komoku 項目名

Data データバッファへのポインタ

戻り値 0 成功


説明フィールドの属性を項目ごとに取得します。以下のパラメータが使用可能

なパラメータとなります。

項目名記述取得内容

開始 X 座標 X 0 以上（ドット）

開始 Y 座標 Y 0 以上（ドットで）

全角フォント ZenFont 0:明朝体 1:ゴシック

半角フォント HanFont 0:全角フォント

1:クーリエ

文字サイズ Size 1.0～96.0

桁数 Keta 1～256

半角／全角 HanZen 0:半角 1:全角

縦倍率 TateBai 0.5,1.0,2.0,3.0,4.0,6.0,8.0

横倍率 YokoBai 0.5,1.0,2.0,3.0,4.0,6.0,8.0

明度 Meido 0:黒 100:白

ボールド Bold 0:しない 1:する

41


項目名記述取得内容

イタリック Ital ic 0:しない 1:する

アウトライン OutLine 0:しない 1:する

シャドウ Shadow 0:しない 1:する

編集スタイル Hensyu 0:無編集 1:右詰め 2:左詰め 3:中央割付

4:均等割付 5:小数点位置固定右詰め

データ型 DataStyle 0:文字 1:数値

印字方向 Direction 0:横 1:縦

回転 Rotation 0,90,180,270

計算式 Calc 計算式

編集式 Edit 編集式

リンクフィールド名 LinkFie ld リンクするフィールド名

綴りページ指定 Tsuzuri 0:印字しない 1:印字する

入力ロック Lock 0:しない 1:する

総ページ数 TotalPageCount 総ページ数

帳票連番の取得 SerialPageCount 帳票連番

ファイル名の取得 $SPOOLFILENAME$ ファイル名

使用例 ① ［単価］フィールドの全角フォントの属性を変数［Data］に格納します。

svf.VrGetAttribute(“単価”, “ZenFont”, Data);

svf.VrGetAttribute(“単価”, “ZenFont”, Data)

VrGetAttribute(svf, “単価”, “ZenFont”, Data);

② ［金額］フィールドの計算式を変数［Data］に格納します。

svf.VrGetAttribute(“金額”, “Calc”, Data);

svf.VrGetAttribute(“金額”, “Calc”, Data)

VrGetAttribute(svf, “金額”, “Calc”, Data);

42

3 API 関数

③ 総ページ数を変数［Buff］に格納します。

svf.VrGetAttribute(“”, “TotalPageCount”, Buff);

svf.VrGetAttribute(“”, “TotalPageCount”, Buff)

VrGetAttribute(svf, “”, “TotalPageCount”, Buff);

④ 作成したファイル名を変数［Buff］に格納します。

svf.VrGetAttribute(“$SPOOLFILENAME$”,””,Buff);

svf.VrGetAttribute(“$SPOOLFILENAME$”,””,Buff)

VrGetAttribute(svf,”$SPOOLFILENAME$”,””,Buff);

ASP 言語を利用している場合、ASP 上で定義する変数に明確な型が存在しないた

め、型変換がおこなえません。このため、VrGetAttribute 関数は使用できません。

VrGetAttribute 関数でフィールドの属性を取得する場合に、言語によっては、変数定

義時に Buffer エリアを取っていないとアプリケーションエラーが発生する場合があります。

VB 言語を利用している場合は、「Dim szBuffer as String * 256」というような形で指

定してください。Java の場合には、StringBuffer を利用してください。

サブフォームとレコードが設計されている様式を利用した出力、またはクエリーファイルを

利用した出力をおこなう場合、 ”TotalPageCount”および ”$SPOOLFILENAME$”は

VrPrint 関数を発行した後に実行してください。

Java コネクト・ASP/COM コネクトから利用する場合は、”$SPOOLFILENAME$”で取得

されるファイル名は一時ファイル名となります。これはファイルを生成するコンピュータでは

一時ファイルを作成し、呼び出し元のアプリケーションサーバ側へ生成ファイルを戻すと

いう動作をしているため、$SPOOLFILENAME$を取得する時には、一時ファイルしか生

成されていない状態であることが要因となります。

“X””Y”ではフィールドの座標を取得することは可能ですが、サブフォームやレコードなど

のアイテムの座標を取得することはできません。

43


VrTest

機能テスト印刷を実行します。


int instance.VrTest();

Long object.VrTest()

int VrTest(HSVFRCLIENT instance);

引数なし

戻り値 0 成功


説明 VrSetForm 関数で定義した様式ファイルのテスト印刷を実行します。


svf.VrTest();

svf.VrTest()

VrTest(svf);

VrTest 関数は、設計部の［印刷］メニューの［テスト印刷］で［簡易印刷］モードを設定

して実行する時と同様の出力結果になります。

VrTest 関数を使用する場合は、様式ファイルの中にサブフォームとレコードが設計され

ているフォームでも VrSetForm 関数の Mode はかならず「1」としてください。

関数使用順

svf.VrInit();

svf.VrSetPrinter(“”, “printer”);


svf.VrTest();

svf.VrEndPage();

svf.VrQuit();

44

3 API 関数

VrPaperEject

機能プリンタ内部に残っている用紙を排出します。ドットプリンタで連続用紙を

設定している場合は、さらに 1 ページ分改ページをおこないます。


int instance.VrPapreEject();

Long object.VrPaperEject();

int VrPaperEject(HSVFRCLIENT instance);

引数なし

戻り値 0 成功


説明両面印刷実行時に、奇数ページで印刷が終了すると、プリンタ内部に最

終ページが残ります。印刷終了時にこの関数を実行すると、最終ページ

が自動的に排出されます。

また、連写機能を使用した様式ファイルを実行する場合、1 ページ内の

すべての連写アイテムに満たない数で最終ページが終了した場合にも、

VrPaperEject 関数でページの排出が可能です。


svf.VrPaperEject();

svf.VrPaperEject()

VrPaperEject(instance);

PostScript ・ FujiXeroxDPSeries ・ UNISYS JPP を利用して出力する場合には、

VrPaperEject 関数が発行されても有効になりません。

両面印刷で片面印刷終了時の排出処理や、ドットプリンタでの改ページ処理の制御に

ついては、プリンタの機種により機能しない場合があります。

45


VrSeqOut

機能シーケンシャルモードでの文字列を出力します。


int instance.VrSeqOut(String Data);

Long object.VrSeqOut(String Data)

int VrSeqOut(HSVFRCLIENT instance, Char *Data);

引数 Data データ

戻り値 0 成功


説明 VrSetForm 関数によって定義する出力モードがシーケンシャル

（Mode=0）の場合、VrSeqOut 関数でデータをフィールドの設計されてい

る座標順（左上から右下）に出力します。出力できるデータは文字列に

限ります。基本は SVF 内部で保有するバッファ順に格納されます。通常

は上から順で、繰り返し行であっても優先されません。

4XXX 3XX

4RRR

と様式に設計した場合

VrSeqOut(h, “0001”) VrSeqOut(h, “002”) VrSeqOut(h, “0003”) の順に出力すると

0001 002

0003

と出力します。

使用例文字列「Data」をフィールドに送ります。

svf.VrSeqOut(“Data”);

svf.VrSeqOut(“Data”)

VrSeqOut(svf, “Data”);

46

3 API 関数

関数使用順

svf.VrInit();

svf.VrSetPrinter(“”, printer);


svf.VrSeqOut(“Data1”);

svf.VrSeqOut(“Data2”);

：

svf.VrEndPage();

svf.VrQuit();

VrPage

機能綴りが複数ページで構成されている様式の印字対象ページを指定します。


int instance.VrPage(String Page);

Long object.VrPage(String Page)

int VrPage(HSVFRCLIENT instance, Char *Page);

引数 Page 1 印字するページ

0 印字しないページ

戻り値 0 正常


説明様式ファイル設計上の［ページの基本設定］ダイアログボックスで、「綴

り」ページを「2」以上に設定している場合で、かつ、綴りページをページご

とに印字するかどうかを指定したい場合に利用します。

VrPage 関数が発行されない場合には、すべての綴りページが出力され

ます。一度印字対象ページを指定すると次に異なるページを指定するか、

VrSetForm 関数で新しい様式ファイルが指定されるまで有効となりま

す。

使用例綴りページが「5」の際に、綴りページの 1,2,5 ページを印字し、3,4 は印字し

ません。

svf.VrPage(“11001”);

svf.VrPage(“11001”)

47


VrPage(svf, “11001”);

ドットプリンタに出力をおこなう場合には、綴りページの設定自身が無効となるため、

VrPage 関数がコールされても有効にはなりません。

関数使用順

svf.VrInit();

svf.VrSetPriniter(“”, printer);


svf.VrPage(“11001”);

svf.VrsOut(“Field”, “Data”);

svf.VrEndPage();

svf.VrQuit();

VrSetCalcMode

機能最大 33 桁（整数部＋小数部）の十進演算ライブラリをサポートします。


int instance.VrSetCalcMode(int Mode);

Long object.VrSetCalcMode(int Mode)

int VrSetCalcMode(HSVFRCLIENT instance, int Mode);

引数 Mode 演算動作設定

0 DOUBLE 型演算（デフォルト）

1 多倍精度十進浮動小数点型演算

戻り値 0 成功


説明 15 桁以上の数値データを扱う場合に使用します。この関数を呼び出す

と、数値データを 33 桁まで出力することができます。この関数による指定

がない場合には、 vfreport.properties ファイルの設定に従います。

Vfreport.properties ファイルの設定については、以下を参照してくださ

い。

48

3 API 関数


svf.VrSetCalcMode(1);

svf.VrSetCalcMode(1)

VrSetCalcMode(svf,1);

演算結果が最大有効桁数を超えた場合は、最下位桁が切り捨てられます。

また演算途中で最大有効桁数を超えた場合も、その時点の結果の最下位桁が切り

捨てられます。

多倍精度十進浮動小数点型演算を利用する場合には、数値型フィールドに対して数

値データを出力する関数として VrsOut/VrsOutn 関数を利用し、数値データを文字列

データとして出力してください。

vfreport.properties ファイルを変更する場合は、以下の設定箇所以外は変更しないで

ください。他部分を変更すると SVF Java PRODUCTS の動作が変わってしまう場合が

あります。そのような場合には、サポート範囲外となる可能性もありますので、ご了承くだ

さい。

≪vfreport.properties の設定方法≫

1 SVFJava PRODUCTS セットアップフォルダの中の「 ./svfjp/svfjpd/l ib 」下にある

vfreport.properties ファイルをテキストエディタで開きます。

2 以下の設定内容を、次のように変更して、上書き保存します。

変更前 Fcl ib.UseMPL=False

↓

変更後 Fcl ib.UseMPL=True

関数使用順

svf.VrInit();

svf.VrSetCalcMode(1);




svf.VrEndPage();

svf.VrQuit();

この部分は基本的なプログラム

の流れを参照してください。

49


VrGetStatus

機能ステータスを取得します。


int instance.VrGetStatus();

Long object.VrGetStatus()

int VrGetStatus(HSVFRCLIENT instance);

引数なし

戻り値 0 正常


説明戻り値にこの関数の前に実行された関数の実行結果を戻します。

VrOutputQuery

機能 VrSetQuery 関数で指定したクエリーを実行した際にデータベースから取

得されたデータを指定したファイルに CSV 形式で保存します。


int instance.VrOutputQuery(String FileName);

int object.VrOutputQuery(String FileName)

int VrOutputQuery(HSVFRCLIENT instance, Char *FileName);

引数 Fi leName 保存する CSV ファイル名をフルパスで指定します。

戻り値 0 成功


説明 VrSetQuery 関数で実行をおこなうクエリーファイルの内容に従ってデー

タベースから取得した内容を、CSV 形式（カンマ区切り）のファイルとして

出力します。

50

3 API 関数


svf.VrOutputQuery(“c:¥¥svf¥¥data.csv”);

svf.VrOutputQuery(“c:¥inetpub¥wwwroot¥svf¥data.csv”)

VrOutputQuery(svf, “c:¥inetpub¥wwwroot¥svf¥data.csv”);

VrOutputQuery 関数は、データベースから取得したデータを CSV に出力する関数で

す。様式ファイル内に設定してある編集式や計算式は適用されません。編集式や計算

式を反映した形で CSV ファイルを出力したい場合は、別途 SVF for Web / CSV

JavaEdition をご利用ください。

関数使用順

svf.VrInit();



svf.VrSetQuery(“UID=xxx;PWD=xxx”, “sample.vrq”, 0);

svf.VrOutputQuery(“data.csv”);

svf.VrReport();

svf.VrPrint();

svf.VrQuit();

共通関数-2（Java コネクト、および ASP/COM コネクト以外）

この項の関数は、Java コネクト、および ASP/COM コネクト以外の SVF Java PRODUCTS

製品において利用可能な関数です。

VrGetFieldCount

機能様式ファイル内に設計されているフィールドの総数を取得します。


int instance.VrGetFieldCount();

引数なし

戻り値整数フィールド数


51


説明 VrSetForm()関数で指定された、様式ファイル内に設計されているフィー

ルドの数を戻り値として返します。


int count = svf.VrGetFieldCount();

VrGetFieldName

機能フィールド名を取得します。


int instance.VrGetFieldName(int index, StringBuffer buf);

引数 index フィールドインデックス

（0 以上 VrGetFieldCount で取得した数以下）

buf フィールド名格納先

戻り値 0 正常


説明 VrGetFieldCount()関数で取得したフィールド数以下の値をインデックス

として指定することで、そのインデックスのフィールド名を取得することが

できます。


svf.VrGetFieldName(count, buf);

VrGetFieldType

機能フィールドのデータ型を取得します。


int instance.VrGetFieldType(int index);



戻り値 0 文字型

1 数値型

2 バーコードフィールド

3 ビットマップフィールド


52

3 API 関数


として指定することで、そのインデックスのフィールドのタイプを取得するこ

とができます。


int type = svf.VrGetFieldType(count);

VrGetFieldLength

機能フィールドの桁数を取得します。


int instance.VrGetFieldLength(int index);

引数 index フィールドインデックス（0 以上 VrGetFieldCount で取得した数

以下）

戻り値整数フィールド桁数



として指定することで、そのインデックスのフィールドの桁数を取得するこ

とができます。

フィールドがリンクフィールドだった場合には、以下のような値を返します。

・リンク元フィールドの場合

リンク先フィールドの桁数も合わせたフィールド桁数を戻り値と

して返します。

・リンク先フィールドの場合

フィールド桁数は 0 が返されます。


int len = svf.VrGetFieldLength(count);

リンク先フィールドに出力されるデータは、もとがリンク元フィールドにのみ出力されている

データであるため、リンク先フィールドに直接データが出力されているわけではありませ

ん。そのため、戻り値として「0」が返されます。

VrGetFieldRepeatCount

機能フィールドの繰り返し数を取得します。


int instance.VrGetFieldRepeatCount(int index);

53




戻り値整数繰り返し数



として指定することで、そのインデックスのフィールドの繰り返し数を取得

します。

繰り返しフィールドでない場合は、戻り値として 0 を返します。1 以上が返

ってきた場合は、データを出力する際に Vr?Outn 関数を利用し、繰り返

し行数を指定してデータを出力してください。


int repeat = svf.VrGetFieldRepeatCount(index);

繰り返しフィールドに対して Vr?Outn()関数を利用して出力する場合は、VrSetForm()

関数のモードが 1 である必要があります。

VrGetFieldRecordType

機能フィールドが入っているレコードの属性を取得します。


int instance.VrGetFieldRecordType(int index);



戻り値 0 レコードには属さないフィールド

1 明細レコードに属するフィールド

2 合計レコードに属するフィールド

3 ヘッダーレコードに属するフィールド

4 総計レコードに属するフィールド


として指定することで、そのインデックスのフィールドがどのタイプのレコード

に属しているかを取得します。


int record = svf.VrGetFieldRecordType(count);

54

3 API 関数

VrGetPageRecordCount

機能行数を取得します。


int instance.VrGetPageRecordCount();

引数なし

戻り値整数データ行数


説明繰り返しフィールドが作成されている様式ファイルに対して VrSetForm()

関数のモード 4、またはモード 5 で出力しようとした場合の、様式ファイル

内に出力可能なデータ行数を取得します。


int record_cnt = svf.VrGetPageRecordCount();

繰り返しフィールドを使用している様式ファイルを利用して VrSetForm()関数のモード

4、またはモード 5 で出力する場合は、Vr?Out()関数を利用して 1 行分の繰り返し行に

対してデータを出力した後に、VrEndRecord()関数を発行してください。

関数使用例

svf.VrInit();

svf.VrSetPrinter("", "PDF");

svf.VrSetForm("sample.frm", 5);

int count = svf.VrGetFieldCount();

for (int i = 0; i < count; i++) {

int rv = svf.VrGetFieldName(i, attr);

ret = svf.VrGetFieldType(i);

ret = svf.VrGetFieldLength(i);

ret = svf.VrGetFieldRepeatCount(i);

ret = svf.VrGetFieldRecordType(i);

}

svf.VrGetPageRecordCount();

svf.VrQuit();

55


SVF for JavaPrint のみで使用できる関数

SVF for JavaPrint で使用できる API 関数は、すべて印刷制御をおこなう関数です。

この印刷制御関数は、プリンタの機種により使用できる場合、使用できない場合がありま

すので、以下の表で使用しているプリンタを確認してください。また使用できる場合となって

いる場合でも、使用できないこともありますので、事前に動作検証をかならずおこなってくだ

さい。

≪対応機種一覧表≫

プリンタ固有の API 関数プリンタ機種解像度

VrSetTray（トレイ番号） VrSetDuplex VrSetOutPutBin（排紙ビン）

PostScript 400dpi InputAtributes 辞書が有効な機種

のみ Duplex 辞書が有効な機種の

み OutputAttributes 辞書が有効

な機種のみ -1 指定なし 0～ InputAttributes 辞書中

のエントリキー。プリンタによっ

て指定のビンが異なります。

LIPS3 300dpi シングルカセット機 0 自動給紙 1 手差し、またはマルチトレイダブルカセット機 0 自動給紙 1 手差し 2 下段カセット 3 上段カセット

× ×

LIPS4 300dpi or 600dpi

0 自動給紙 1 手差し、または MP トレイ 2 下段カセット 3 上段カセット 10 MP トレイ 11～17

カセット 11～17

○ TRAY 排紙トレイに排紙 BIN1 ビン 1 に排紙 BIN2 ビン 2 に排紙 BIN3 ビン 3 に排紙

CAPPL 400dpi 0 第 1 給紙 8 A3 給紙 1 第 2 給紙 9 A4 縦給紙 2 MPF 給紙 10 A4 横給紙 3 MPF 給紙 11 A5 給紙 4 B4 給紙 12 はがき給紙 5 A4or 横給紙 13 第 3 給紙 6 B5 給紙 -1 指定なし 7 MPF 給紙

× ×

N4 300dpi 0 指定なし 1～15 トレイ 1～15

× ×

ドット（ESCP） 180dpi × × ×

ドット（IBM5577） 180dpi × × ×

ドット（PR201） 160dpi × × ×

ESC/PAGE 300dpi ○ ○ ×

ART4 400dpi or 600dpi

- 自動選択 10 差しトレイ手

1～4 トレイ 1～4

21～23 マルチトレイ 2-1～2-3

○ MAINTRAY メイントレイ SIDETRAY サドトレイイ

OUTBIN1～10 メールボックス 1 ビ

～10 ビンン

OUTBIN100 スタッカー

OUTPUTBIN101～105 スタッカー1 ビン～

5 ビン

56

3 API 関数

プリンタ固有の API 関数フォント画像ファイル

VrSetStaple（ステープル） VrSetSort ソート VrSetPunch パンチクーリエ（内蔵） OCR-B（内蔵）白黒 BMP カラーBMP PNG JPG

× × × ○ × ○ ○ ○ ○

× × × ○ × ○ × × ×

OFF 処理をおこないません。 TOPLEFT 左上一箇所 BOTLEFT 左下一箇所 MIDLEFT 左辺二箇所 TOPRIGHT 右上一箇所 BOTRIGHT 右下一箇所 MIDRIGHT 右辺二箇所 TOPCENTER 上辺二箇所 BOTCENTER 下辺二箇所

× × ○ × ○ ○ ○ ×

× × ○ ○ ○ ○ ○ ×

× × × ○ × ○ ○ ○ ×

× × × ○ ○ ○ × × ×

× × × ○ ○ ○ × × ×

× × × ○ ○ ○ × × ×

× × × ○ × ○ × × ×

OFF ステープルなし TOPDUAL 上デュアル TOPLEFT 左上シングル TOPRIGHT 右上シングル BOTTOMDUAL 下デュアル BOTTOMLEFT 左下シングル BOTTOMRIGHT 右下シングル LEFTDUAL 左デュアル RIGHTDUAL 右デュアル

× × ○ × ○ ○ ○ ○

57


プリンタ固有の API 関数プリンタ機種解像度

VrSetTray（トレイ番号） VrSetDuplex VrSetOutPutBin（排紙ビン）

DPSeries 400dpi 0 自動給紙 1 トレイ 1 2 トレイ 2 3 トレイ 3 4 大容量フィーダー 5 手差しトレイ

○ 0 トップトレイ 10 大容量スターカー 11 フェースアップトレイ

VSP 240dpi or 400dpi

-1 指定なし 0 給紙口 1 1 給紙口 2 2 手差しまたは給紙トレイ 3 給紙口 3

× ×

PCL5 300dpi ○ 0～6 から選択

○ ×

PRESCRIBE2 300dpi 0 手差しトレイ 1 カセット 1 2 カセット 2 3 カセット 3 4 カセット 4

○ 0 プリンタの設定 1 フェースダウン 2 フェースアップ 3 ソータ

NPDL2 400dpi 0 指定なし 1 トレイ 1 2 トレイ 2 3 トレイ 3 4 トレイ 4 5 トレイ 5 6 手差し

○ 0 フェイスダウン 1 フェイスアップ 2 フィニッシャ

RPCS 600dpi 0 自動選択 1 トレイ 1 2 トレイ 2 3 トレイ 3 4 トレイ 4 その他に「大容量給紙トレイ」と「手差し」

の割り当てが可能

○ 0 システム条件の設定 3 横排紙トレイ 10 プルーフトレイ 11 プリントポスト 1 12 プリントポスト 2 13 プリントポスト 3 14 プリントポスト 4 15 プリントポスト 5 20 フィニッシャー・シフトトレイ 21 標準トレイ

RPDL2 400dpi 0 指定なし 1～5 トレイ 1～5 6 マルチメディアフィーダ -1 手差し

○

0 システム条件に従う 1 上排紙トレイ(NX1000/1100) 2 中排紙トレイ(NX1000/1100) 3 下排紙トレイ(NX1000/1100) M,0 プリントポスト(プルーフトレイ) M,1 プリントポスト(1 ビン) M,2 プリントポスト(2 ビン) M,3 プリントポスト(3 ビン) M,4 プリントポスト(4 ビン) M,5 プリントポスト(5 ビン) M,6 プリントポスト(6 ビン) M,7 プリントポスト(7 ビン) M,8 プリントポスト(8 ビン) M,9 プリントポスト(9 ビン) F,1 フィニッシャー･シフトトレイ I,0 標準トレイ

JPP 400dpi ○ 不明

○ 不明

58

3 API 関数

プリンタ固有の API 関数フォント画像ファイル

VrSetStaple（ステープル） VrSetSort ソート VrSetPunch パンチクーリエ（内臓） OCR-B（内臓）白黒 BMP カラーBMP PNG JPG

× × × ○ × ○ ○ ○ ○

× × × ○ × ○ × × ×

× × × ○ × ○ ○ ○ ×

0 なし 1 手前 1 箇所 2 奥1箇所斜めもしくは、奥1

箇所平行 3 中央 2 箇所

× 0 なし 1 あり

○ ○ ○ ○ ○ ×

0 しない 1 左上斜め 2 右上斜め 3 左 2 つ 4 上 2 つ 5 右 2 つ

0 しない 1 する

× ○ ○ ○ × × ×

0 なし 1 左上垂直 2 右上垂直 3 左上斜め 4 右上斜め 5 左 2 つ 6 上 2 つ 7 右 2 つ

○ 0 なし 1 左上斜め 2 上 2 つ 3 右上斜め

○ × ○ ○ ○ ×

指定なしステープル処理なし 0,0 左上斜め綴じ 0,1 左上垂直綴じ 0,2 左２ヶ所綴じ 0,10 右２ヶ所綴じ 0,11 右上垂直綴じ 0,12 右上斜め綴じ 0,13 右上水平綴じ 0,14 上２ヶ所綴じ 0,15 左上水平綴じ 1,0 左上綴じ 1,3 右上綴じ

指定なしソート処理なし

1 回転ソートしない 2 回転ソートする

指定なしパンチ処理なし 0 左 2 右 3 上

○ ○ ○ × × ×

× × × ○ × ○ ○ ○ ×

59


VrSetTray

機能出力時の給紙トレイを指定します。


int instance.VrSetTray(int Tray);

Long object.VrSetTray(int Tray);

int VrSetTray(HSVFRCLIENT instance, int Tray);

引数 Tray トレイ番号

0 トレイ指定なし

1 トレイ 1

2 トレイ 2

3 トレイ 3

4 トレイ 4

戻り値 0 成功


説明フォーム設計時に［ページの基本設定］ダイアログボックスで指定できる

［トレイ選択］の設定を VrSetTray 関数で一時的に変更します。トレイ番

号の指定できる数は、SVF for JavaPrint で作成したプリンタの機種によ

り異なります。どの種類で何段指定が可能かについては以下の表を参照

してください。また、ここで指定したトレイ番号は作成されたプリンタの設

定により給紙されるトレイが変わります。給紙トレイの設定方法については、

各製品の［環境設定］を参照してください。

機種指定可能トレイ段数

Adobe PostScript(POSTSCRIPT) トレイ 0～4

Canon LIPS3(LIPS3) トレイ 0～4

Canon LIPS4(LIPS4) トレイ 0～4

CASIO CAPPL/Base(CAPPL) トレイ 0～4

CASIO Color N4/N5(CPN4) トレイ 0～4

EPSON ESC/Page(ESCPAGE) トレイ 0～4

FUJIXEROX ART4(ART4) トレイ 0～4

FUJIXEROX DP Series(DP300) トレイ 0～5

FUJITSU VSP(VSP) トレイ 0～4

60

3 API 関数

機種指定可能トレイ段数

Hewlett-Packard PCL5(PCL5) トレイ 0～4

KYOCERA MITA

PRESCRIBE2(PRESCRIBE2)

トレイ 0～4

NEC NPDL2(NPDL2) トレイ 0～6

RICOH RPCS(RPCS) トレイ 0～4

RICOH RPDL2(RPDL2) トレイ 0～4

UNISYS JPP(JPP) トレイ 0～4

使用例トレイ 2 を指定します。

svf.VrSetTray(2);

svf.VrSetTray(2)

VrSetTray(svf, 2);

関数使用順

svf.VrInit();

svf.VrSetPrinter(“”,printer);

svf.VrSetForm(“sample.frm”,5);

svf.VrSetTray(2); ←VrSetForm 関数の後に発行します。


svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

途中で新しい様式ファイルが指定された場合は、そのフォームの設定に従います。リンク

フォーム機能を使用している場合は、内部的に VrSetForm 関数が発行されますので、

リンク先のフォームの給紙トレイはフォームの設定に従い出力されます。

この関数を発行していない状態で、かつ様式ファイル内でもトレイ指定をおこなっていな

い場合は、用紙サイズをもとにプリンタ実機側で出力をおこないます。同じ用紙サイズが

複数のトレイに入っている場合には、プリンタの設定により給紙トレイが異なります。

この部分は基本的なプログラ

ムの流れを参照してください。

61


VrSetDuplex

機能両面印刷の指定をおこないます。


int instance.VrSetDuplex(int Mode, int Margin);

Long object.VrSetDuplex(int Mode, int Margin);

int VrSetDuplex(HSVFRCLIENT instance, int Mode, int Margin);

引数 Mode 綴じ方向

0 解除

1 上綴じ

2 左綴じ

3 右綴じ

Margin 綴じ代（0～50mm ミリ単位）

戻り値 0 成功


説明両面印刷の指定をおこないます。対応機種については、p.56「対応機種

一覧表」を参照してください。この関数は VrSetForm 関数の後で指定を

おこないます。

使用例左綴じの両面印刷で綴じ代を 10mm と指定します。

svf.VrSetDuplex(2, 10);

svf.VrSetDuplex(2, 10)

VrSetDuplex(svf, 2, 10);

62

3 API 関数

複数の様式ファイルを使用して両面印刷をおこないたい場合

様式変更時の両面印刷の継続方法を３つのモードから選択することができます。

・解除モード

様式ファイルが切り替わった場合、両面印刷を解除します。

・同一条件継続モード

新しい様式ファイル読み込み時に、前回利用した様式ファイルと比較して以下

の条件に 1 つでもあてはまり、かつ印刷が片面で終わった場合は両面印刷され

ずに片面印刷で排出されます。

・用紙サイズが異なる場合

・用紙方向が異なる場合

・給紙トレイが異なる場合

・縮小モードが異なる場合。

・強制継続モード

強制的に両面印刷を継続します。

RPDL2 で出力する場合のみ、綴じ代は 5mm 単位となります。指定された端数は切り捨

てられます。

VSP で出力する場合には、プリンタの制御コマンドとして FNP シーケンスコマンドをプリン

タハード側で搭載している機種のみ両面印刷が可能になります。FNP コマンドでの出力

が必要となるので、 VSP で作成したプリンタの設定ファイル「 vfreport. プリンタ

名 .VSP.properties」をテキストエディタで開き、「PDL=VSP」という部分を「PDL=FNP」と

変更してください。

関数使用順

svf.VrInit();



svf.VrSetDuplex(2, 10);


svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

VrSetMachineKind

機能 RICOH 製プリンタの機種（PC-LA

書式各言語による書式は、以下のとお

int instance.VrSetMachineKind

Long object.VrSetMachineKind

int VrSetMachineKind(HSVFRC



SER 系または MF-P 系）を指定します。

りとなります。

(int Machine);

(int Machine)

LIENT instance, int Machine);

63


引数 Machine 機種

0 PC-LASER 系

1 その他（MF-P 系）

戻り値 0 成功


説明 RICOH 製プリンタの機種を指定することで、PC-LASER 系と MF-P 系の機

種でのトレイ番号が異なるために起こるトレイ指定の不整合をなくします。

この関数は VrSetPrinter 関数と VrSetForm 関数の間で使用します。ま

た、この API 関数による指定がない場合は、［環境設定アプレット］の

［RPDL2］を指定して作成したプリンタの設定内にある［プリンタ機種］の

設定内容に従います。RPDL2 プリンタ以外で出力する場合に、この関数

が発行された場合は、この関数は無視されます。

使用例 PC-LASER 系を指定します。

svf.VrSetMachineKind(0);

svf.VrSetMachineKind(0)

VrSetMachineKind(svf,0);

関数使用順

svf.VrInit();

svf.VrSetPrinter(“”, “RICOH”);

svf.VrSetMachineKind(0);



svf.VrEndPage();



svf.VrQuit();

VrSetOutputBin

機能排紙先を指定します。


int instance.VrSetOutputBin(int Bin);

Long object.VrSetOutputBin(int Bin)

int VrSetOutputBin(HSVFRCLIENT instance, int Bin);

64

3 API 関数

引数 Bin 排紙先トレイ

戻り値 0 成功


説明出力時の排紙先トレイの指定をおこないます。この API 関数の指定がな

い場合にはプリンタ実機で設定されている排紙先に出力されます。指定

可能な排紙先番号は機種により異なります。［環境設定アプレット］にて

作成したプリンタの設定内にある［排紙ビン n］という定義の「n」を指定し

てください。対応機種については、p.56「対応機種一覧表」を参照してく

ださい。

使用例排紙先 1 を指定します。

svf.VrSetOutputBin(1);

svf.VrSetOutputBin(1)

VrSetOutputBin(svf, 1);

ステープル機能を併用する場合には、かならずフィニッシャー・シフトトレイを指定してく

ださい。

VSP で出力する場合には、プリンタの制御コマンドとして FNP シーケンスコマンドをプリン

タハード側で搭載している機種のみ両面印刷が可能になります。FNP コマンドでの出力

が必要となるので、 VSP で作成したプリンタの設定ファイル「 vfreport. プリンタ

名 .VSP.properties」をテキストエディタで開き、「PDL=VSP」という部分を「PDL=FNP」と

変更してください。

関数使用順

svf.VrInit();


svf.VrSetForm(“/home/svf/sample.frm”, 5);



svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

65


VrSetStaple

機能ステープル機能の指定をします。


int instance.VrSetStaple(int Location);

Long object.VrSetStaple(int Location)

int VrSetStaple(HSVFRCLIENT instance, int Location);

引数 Location 綴じ位置

戻り値 0 成功


説明ステープル機能の指定をおこないます。指定可能なステープル番号は

機種により異なります。

［環境設定アプレット］で作成したプリンタの設定内にある［ステープル n］

という定義の「n」を指定してください。

対応機種については、p.56「対応機種一覧表」を参照してください。

使用例ステープル番号「2」を指定します。

svf.VrSetStaple(2);

svf.VrSetStaple(2)

svf.VrSetStaple(svf, 2);

排紙トレイには、かならずフィニッシャー･シフトトレイを指定します。

両面印刷機能やパンチ機能と併用する場合には、かならず綴じ方向を合わせます。

用紙方向により指定の位置で綴じることができない場合があります。用紙方向・指定

位置などの可否の確認は各プリンタ付随のマニュアルで確認してください。

66

3 API 関数

関数使用順

svf.VrInit();




svf.VrSetStaple(1);


svf.VrEndPage();

svf.VrQuit();

VrSetSort

機能出力紙のソートを指定します。


int instance.VrSetSort(int Condition);

Long object.VrSetSort(int Condition)

int VrSetSort(HSVFRCLIENT instance, int Condition);

引数 Condition ソート条件

戻り値 0 成功


説明出力紙のソートをおこないます。指定可能なステープル番号は機種によ

り異なります。［環境設定アプレット］で作成したプリンタの設定内にある

［ステープル n］という定義の「n」を指定してください。対応機種について

は、p.56「対応機種一覧表」を参照してください。また、各種ソート条件は

プリンタ付随のマニュアルを参照してください。

使用例ソートをおこないます。

svf.VrSetSort(1);

svf.VrSetSort(1)

VrSetSort(svf, 1);

67


関数使用順

svf.VrInit();



svf.VrSetSort(1);


svf.VrEndPage();

svf.VrQuit();

VrSetPunch

機能パンチ機能の指定をします。


int instance.VrSetPunch(int Locatiion);

Long object.VrSetPunch(int Location)

int VrSetPunch(HSVFRCLIENT instance, int Location);

引数 Location パンチ指定

戻り値 0 成功


説明パンチの指定をおこないます。指定可能なパンチ番号は機種により異な

ります。［環境設定アプレット］で作成したプリンタの設定内にある［パンチ

n］という定義の「n」を指定してください。対応機種については、p.56「対応

機種一覧表」を参照してください。

使用例パンチを指定します。

svf.VrSetPunch(1);

svf.VrSetPunch(1)

VrSetPunch(svf, 1);

68

3 API 関数

69

排紙トレイには、かならずフィニッシャー･シフトトレイを指定します。

両面印刷やステープル機能と併用する場合には、綴じ方向を合わせます。

用紙方向によっては指定の位置にパンチができない場合があります。用紙方向・指定

位置などの可否の確認は各プリンタ付随のマニュアルで確認してください。

関数使用順

svf.VrInit();




svf.VrSetPunch(1);


svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();


SVF for Web / PDF JavaEdition のみで使用できる関数

SVF for Web / PDF JavaEdition で使用できる API 関数は、PDF・EMF 生成時のファイル

作成方法の指定、および PDF 生成時にのみ利用可能な関数となります。

VrSetSpoolFileStream

機能ファイル生成時にディスク上のファイルにではなく、メモリに出力をおこな

います。


int instance.VrSetSpoolFileStream(OutputStream os);

使用できません。

使用できません。

引数 os 出力先ストリームオブジェクト

戻り値 0 成功


説明 VrSetSpoolFi leName2 関数で出力先 PDF ファイル名を指定する代わり

に、この関数を使用すると、出力ファイルを物理ファイルとして生成するの

ではなく、メモリ上に Stream 出力することが可能になります。この機能を

利用することで、Servlet などからクライアントに PDF ファイルを URL から

戻す際に、URL からの PDF ファイルの実参照を防ぐことが可能になります。

VrQuit 関数実行時に戻り値として Stream 出力をおこなった PDF のサイ

ズが戻り値として返されます。

Java 言語の Stream 機能を利用しているため、ASP/COM コネクトを利用している場合

には、本関数を利用することはできません。

SetContentType・setContentLength は SVFJava PRODUCTS 製品群の関数ではあ

りません。しかし、この 2 つの関数が Java プログラム内で指定がされていない場合は、

PDF をブラウザに表示できないことがありますので、かならず使用してください（Internet

Exproler を利用している場合）。

70

3 API 関数

関数使用例

public void doPost(HttpServletRequest req, HttpServletResponse res) {

res.setContentType(“application/pdf”);

OutputStream os = res.getOutputStream();

Vrw32 svf = new Vrw32();

int ret;

svf.VrInit();


svf.VrSetSpoolFileStream(os);



svf.VrEndRecord();

svf.VrPrint();

ret = svf.VrQuit();

res.setContentLength(ret );

os.close();

}

VrComout(“/{SECU n}/”)

機能 PDF のセキュリティ機能の有無を設定します。


int instance.VrComout(“/{SECU n}/”);

Long object.VrComout(“/{SECU n}/”)

int VrComout(HSVFRCLIENT instance, “/{SECU n}/”);

引数 n モードを指定します。

0 セキュリティ機能を使用しません。

1 セキュリティ機能を使用します。

戻り値 0 成功


説明作成する PDF ファイルに対してセキュリティ機能を使用する場合に利用

します。

この関数が指定されていない場合は、環境設定の指定に従います。

71


使用例セキュリティ機能を使用します。

svf.VrComout(“/{SECU 1}/”);

svf.VrComout(“/{SECU 1}/”)

VrComout(svf, “/{SECU 1}/”);

VrComout(“/{PSWD Password}/”)

機能 PDF オープン時のパスワードを設定します。


int instance.VrComout(“/{PSWD password}/”);

Long object.VrComout(“/{PSWD password}/”)

int VrComout(HSVFRCLIENT instance, “/{PSWD password}/”);

引数 password

ユーザーパスワード

戻り値 0 成功


説明 PDF ファイルを開くときにパスワード入力を求める画面が表示されます。こ

の指定をおこなうことにより、PDF ファイルの閲覧を許可する、しないなど

の制限（セキュリティ）をかけることが可能になります。

指定できるパスワード文字列は、32 バイトまでとなります。

使用例 PDF オープン時のパスワードとして「userlock」と指定します。

svf.VrComout(“/{PSWD userlock}/”);

svf.VrComout(“/{PSWD userlock}/”)

VrComout(svf, “/{PSWD userlock}/”);

72

3 API 関数

パスワードとして指定する文字はかならず半角英数文字としてください。2 バイト文字な

どは Acrobat の仕様上、利用することができません。

セキュリティパスワードの指定と併用する場合には、かならず異なるパスワード文字列を

指定してください。同じパスワード文字列が指定された場合は、セキュリティパスワードは

設定されません。

パスワード文字列は 32 バイト以内で設定してください。

VrComout(“/{SECUPSWD Password}/”)

機能 PDF のセキュリティパスワードを設定します。


int instance.VrComout(“/{SECUPSWD password}/”);

Long object.VrComout(“/{SECUPSWD password}/”)

int VrComout(HSVFRCLIENT instance, “/{SECUPSWD password}/”);

引数 password

セキュリティパスワード

戻り値 0 成功


説明 Acrobat 使用時に設定できる各種セキュリティ変更をおこなうためのパ

スワードを設定します。

この指定をおこなうことにより、PDF のセキュリティ変更保護をおこなうこと

が可能になります。

指定できるパスワード文字列は、32 バイトまでとなります。

使用例 PDF セキュリティ変更のためのパスワードとして「seculock」と指定します。

svf.VrComout(“/{SECUPSWD seculock}/”);

svf.VrComout(“/{SECUPSWD seculock}/”)

VrComout(svf, “/{SECUPSWD seculock}/”);

73


パスワードとして指定できる文字は、かならず半角英数字としてください。2 バイト文字は

は Acrobat の仕様上利用することができません。

PDF オープン時のパスワードの指定と併用する場合は、かならず異なるパスワードを指定し

てください。同じパスワード文字列を指定すると、セキュリティパスワードは設定されません。

パスワード文字列は、かならず 32 バイト以内で設定してください。

VrComout(“/{PERM n}/”)

機能禁止項目の指定をおこないます。

設定できる項目は以下のものとなります。

・印刷

・文書の変更

・テキストとグラフィックス選択

・注釈とフォームフィールドの追加


int instance.VrComout(“/{PERM n}/”);

Long object.VrComout(“/{PERM n}/”)

int VrComout(HSVFRCLIENT instance, “/{PERM n}/”);

引数 n 禁止項目の組み合わせ数値

p 印刷禁止

d 文書の変更禁止

t テキストとグラフィックス選択の禁止

f 注釈とフォームフィールドの追加の禁止

p+d+t+f -64

p+d+t -32

p+d+f -48

p+t+f -56

p+d -16

p+t -24

p+f -40

d+t+f -60

d+t -28

d+f -44

t+f -52

p -8

d -12

t -20

f -36

すべて許可 -4

74

3 API 関数

戻り値 0 成功


説明 PDF ファイル生成時にセキュリティの禁止項目の指定をおこないます。禁

止項目の設定は、項目の組み合わせにより該当するパラメータを指定す

ることで可能になります。

使用例作成する PDF に「印刷禁止」の設定をおこないます。

svf.VrComout(“/{PERM –8}/”);

svf.VrComout(“/{PERM –8}/”)

VrComout(svf, “/{PERM –8}/”);

SVF for Web / PDF JavaEdition Ver2.0 以降では、環境設定アプレット上でも禁止項

目の設定が可能になっています。設定方法については、「SVF for Web / PDF Java

Edition ユーザーズ・マニュアル」の「環境設定-機種別設定」で「PDF」の項を参照してく

ださい。

環境設定と VrComout の両方で禁止項目を設定した場合は、VrComout 関数による

設定が有効となります。

関数使用順

svf.VrInit();


svf.VrSetSpooleFileName2(“sample.pdf”, 5);


svf.VrComout(“/{SECU 1}/”); セキュリティを有効にする

svf.VrComout(“/{PERM –64}/”); 禁止項目の指定

svf.VrComout(“/{PSWD userlock}/”); UserPassWord の指定

svf.VrComout(“/{SECUPSWD seculock}/”); SecurityPassWord の指定

svf.VrsOut(“F1”, “data”);

svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

75


VrComout(“/{EXCL xlsname}/”)

機能 Chart 機能を利用する際の Excel ファイル名を指定します。


int instance.VrComout(“/{EXCL xlsname}/”);

Long object.VrComout(“/{EXCL xlsname}/”)

int VrComout(HSVFRCLIENT instance, “/{EXCL xlsname}/”);

引数 xlsname Excel ファイル名、およびパスを指定します。

戻り値 0 正常


説明 Chart 機能を利用する際に、PDF ファイル内に書きこむグラフが保存され

ている Exccel ファイル名を指定します。この関数は Chart 機能利用時に

は必須となります。

使用例 chart.xls を指定します。

svf.VrComout(“/{EXCL /home/svf/chart.xls}/”);

svf.VrComout(“/{EXCL c:¥svf¥chart.xls}/”)

VrComout(svf, “/{EXCL chart.xls}/”);

VrComout(“/{SSHT Sheet}/”)

機能 Chart 機能を利用する際の Excel ファイルのシート名を指定します。


int instance.VrComout(“/{SSHT Sheet}/”);

Long object.VrComout(“/{SSHT Sheet}/”)

int VrComout(HSVFRCLIENT instance, “/{SSHT Sheet}/”);

76

3 API 関数

ｓ

引数 Sheet Excel シート名

戻り値 0 正常


説明 Chart 機能を利用する際に、VrComout(“/{EXCL xlsname}/”)関数に

て指定された Excel ファイルのデータが入っているシートを指定します。こ

の関数は Chart 作成時に Excel ファイル上でデータ変更をおこないたい

場合に使用します。Excel ファイル内に作成されているグラフをそのまま

PDF 出力する場合には、使用する必要はありません。

使用例データシート名「data」を指定します。

svf.VrComout(“/{SSHT data}/”);

svf.VrComout(“/{SSHT data}/”)

VrComout(svf, “/{SSHT data}/”);

VrComout(“/{SDAT gyono,lineno,data}/”)

機能 Chart 機能を利用する際の Excel ファイルのデータを変更します。


int instance.VrComout(“/{SDAT gyono,lineno,data}/”);

Long object.VrComout(“/{SDAT gyono,lineno,data}/”)

int VrComout(HSVFRCLIENT instance, “/{SDAT gyono,lineno,data}/”);

引数 gyono 行番号

l ineno 列番号

data データ

戻り値 0 正常


説明 Chart 機能を利用する際に、VrComout(“/{SSHT Sheet}/”)関数で指

定したシート内のデータを変更して PDF ファイル内にグラフを生成します。

ここでの番号は 0 が初期値となりますので、MS Excel 上で表示されてい

る行数・列数から 1 を引いた値を定義します。

この関数は PDF 生成時に、グラフ内のデータを変更したい場合に使用し

ます。Excel ファイル内に生成されているグラフをそのまま PDF 出力する

場合には、指定する必要はありません。

77


使用例 B 列 3 行目に設定されているデータを変更します。

svf.VrComout(“/{SDAT 1,2,1000}/”);

svf.VrComout(“/{SDAT 1,2,1000}/”)

VrComout(svf, “/{SDAT 1,2,1000}/”);

VrComout(“/{CGRP BmpField,ChartSheet}/”)

機能 Chart 機能を利用する際のグラフ出力をおこないます。


int instance.VrComout(“/{CGRP BmpField,ChartSheet}/”);

Long object.VrComout(“/{CGRP BmpField,ChartSheet}/”)

int VrComout(HSVFRCLIENT instance, “/{CGRP BmpField,ChartSheet}/”);

引数 BmpField ビットマップフィールド名

ChartSheet グラフシート名

戻り値 0 正常


説明 Chart 機能を利用する際に PDF ファイルへのグラフ生成をおこないます。

様式ファイル内に設計したビットマップフィールド名（グラフ生成個所）と、

VrComout(“/{EXCL xlsname}/”)関数で指定した Excel ファイルのグラ

フが作成されているシート名を指定します。この関数は Chart 機能利用

時に必須となります。

使用例ビットマップフィールド「BMP」にシート名「Chart」のグラフを作成します。

svf.VrComout(“/{CGRP BMP,Chart}/”);

svf.VrComout(“/{CGRP BMP,Chart}/”);

VrComout(svf, “/{CGRP BMP,Chart}/”);

78

3 API 関数

関数使用順

svf.VrInit();


svf.VrSetSpoolFileName2(“sample.pdf”);


svf.VrComout(“/{EXCL chart.xls}/”); Excel ファイルの指定

svf.VrComout(“/{SSHT data}/”); データシートの指定

svf.VrComout(“/{SDAT 2,1,1000}/”); Chart データ出力



svf.VrComout(“/{CGRP BMP,Chart}/”); BMP フィールドへ Chart 作成

svf.VrsOut(“F1”, “data”); フィールドへデータ出力

svf.VrEndPage();

svf.VrQuit();

VrComout("/{FOUT n}/")

機能フィールドが存在しない帳票を出力するか、しないかを設定します。


int instance.VrComout("/{FOUT n}/");

Long object VrComout("/{FOUT n}/")

int VrComout(HSVFRCLIENT instance,"/{FOUT n}/");

引数 n モードを指定します。規定値は 0 となります。

0 フィールドが存在しない帳票を出力しません。

1 フィールドが存在しない帳票を出力します。

戻り値 0 正常


説明フィールドが存在しない帳票を PDF 出力させる場合に利用します。

この関数が指定されていない場合は、規定値(0：出力しない)となります。

使用例フィールドが存在しない帳票を PDF 出力します。

svf.VrComout("/{FOUT 1}/");

79


svf.VrComout("/{FOUT 1}/")

VrComout(svf,"/{FOUT 1}/");

VrComout("/{DATE DateData}/")

機能演算ライブラリの DATE()、TIME()が返す値が指定の日付・時刻になるよ

うに設定します。


int instance.VrComout("/{DATE[TIME] YYYY/MM/DD [HH:MM:SS]}/");

Long object VrComout("/{DATE[TIME] YYYY/MM/DD [HH:MM:SS]}/")

int VrComout("/{DATE[TIME] YYYY/MM/DD [HH:MM:SS]}/");

引数 YYYY/MM/DD

YYYY/MM/DD 形式で日付を指定します。

HH:MM:SS

HH:MM:SS 形式で時刻を指定します。

戻り値 0 正常


説明演算ライブラリの DATE(),TIME()が返す値が指定の日付・時刻になるよ

うに設定します。

使用例 DATE()の戻り値に 2004/02/14 を指定します。

svf.VrComout("/{DATE 2004/02/14}/");

svf.VrComout("/{DATE 2004/02/14}/")

VrComout(svf,"/{DATE 2004/02/14}/");

80

3 API 関数

SVF for Web / CSV JavaEdition のみで使用できる関数

SVF for Web / CSV JavaEdition で使用できる API 関数は CSV ファイル生成時のファイ

ル作成方法を指定する関数となります。

VrSetCSVFileName

機能様式ファイルの設計に従って、出力結果を CSV 形式のファイルに出力し

ます。


int instance.VrSetCSVFileName(String FileName, int Level, int Mode);

Long object.VrSetCSVFileName(String FileName, int Level, int Mode)

int VrSetCSVFileName(HSVFRCLIENT instance, Char *FileName, int Level, int Mode);

引数 Fi leName 出力する CSV ファイル名（パスを含む）

Level 変換レベル（0～2）

0 単純変換（縦罫線での区切りなし）

1 単純変換（縦罫線での区切りあり）

2 複雑変換（縦罫線での区切りあり、同列のデータ数を

考慮）

Mode 変換モード（0or1）

0 フィールド文字列のみ出力

1 フィールド文字列と固定文字出力

戻り値 0 成功


説明作成する CSV ファイル名と作成場所を指定します。この関数を発行しな

い場合は、環境設定アプレット画面上で作成された CSV プリンタの詳細

定義での指定内容に従います。環境設定の詳細については、「SVF for

Web / CSV JavaEdition ユーザーズ・マニュアル」の「環境設定－機種別

詳細設定」の項を参照してください。

使用例「sample.csv」を複雑変換でフィールドと固定文字を出力して作成しま

す。

svf.VrSetCSVFileName(“/home/svf/sample.csv”, 2, 1);

81


svf.VrSetCSVFileName(“c:¥svf¥sample.csv”, 2, 1)

VrSetCSVFileName(svf, “c:¥¥svf¥¥sample.csv”, 2, 1);

関数使用順

svf.VrInit();

svf.VrSetPrinter(“”, “CSV”);

svf.VrSetCSVFileName(“sample.csv”, 2, 1);



svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

82

3 API 関数

SVF for FaxPress / JavaEdition のみで使用できる関数

SVF for FaxPress / JavaEdition で使用できる API 関数は FaxPress 経由で Fax 送信

をおこなう関数となります。

VrSendFaxPress

機能 Fax 送信時のあて先などを指定します。


int instance.VrSendFaxPress(String FaxInformation);

Long object.VrSendFaxPress(String FaxInformation)

int VrSendFaxPress(HSVFRCLIENT instance, Char *FaxInformation);

引数 FaxInformation

Fax 送信情報を以下の順で文字列として指定します。

FaxNo Fax 番号（必須）を指定します。

利用可能な記号は以下の 6 種類となります。半角

文字 50 文字以内で指定します。

「：」、「（」、「）」、「＊」、「-」、「＃」

FaxCompany

送信先会社名を指定します。

利用可能な記号は以下の 4 種類となります。51 バイ

ト以内で指定します。

「（」、「）」、「＜」、「＞」

FaxSection

送信先部署名を指定します。

送信先部署名にて利用可能な記号は以下の 4 種

類となります。50 バイト以内で指定します。「（」、「）」、

「＜」、「＞」

FaxName

送信先氏名を 50 バイト以内で指定します。

FaxSenderName

送信者氏名を 47 バイト以内で指定します。

FaxComment

Fax 件名を 47 バイト以内で指定します。改行コード

を文字列の中に入れて出力することはできません。

83


FaxWithCover

カバー用紙有無を「True」か「False」で指定します。

True あり

False なし

FaxCoverPage

カバー用紙ファイルを指定します。

FaxMassage

カバー用紙内のコメントを指定します。

コメントの指定は 960 バイト以内でおこないます。

改行コードを文字列の中に入れて出力することはで

きません。

FaxDate

タイマ送信日時を指定します。

タイマ送信日時の指定は、半角文字 14 文字以内

でおこないます。指定した日時がすでに過ぎている場

合は、エラーとなります。

戻り値 0 正常


説明 Fax 送信時に必要な情報を、カンマで区切り、1 つの文字列として指定

します。必須項目は Fax 番号のみとなります。

送信先会社名・送信先部署名・送信先氏名・送信者氏名・件名・カバ

ー用紙ファイル名・メッセージは Fax カバー用紙ありの場合に有効となり

ますが、マクニカ社提供の FaxMain 画面で確認することも可能になりま

す。Fax カバー用紙は、指定がない場合には添付されません。カバー用紙

をつける場合に、「True」と指定してください。

タイマ送信日時は、送信先に時刻指定で Fax 送信したい場合に指定し

ます。

また、Fax 番号の後ろに”$9600”と記述することにより、Fax 送信時の転

送速度を指定することが可能です。指定可能な転送速度は 2400・

4800・7200・9600・12000・14400 の 6 種類で、この内 1 つを指定でき

ます。転送速度を指定しない場合は、デフォルトとして 14400 で送信され

ます。


svf.VrSendFaxPress(“03-5766-XXXX$9600,,,,,,,,,”);

svf. VrSendFaxPress(“03-5766-XXXX$9600,,,,,,,,,”)

VrSendFaxPress(svf, “03-5766-XXXX$9600,,,,,,,,,”)

84

3 API 関数

SVF for SignedPDF Server / JavaEdition のみで使用できる関数

SVF for SignedPDF Server / JavaEdition で使用できる API 関数は、SignedPDF を利用

して電子署名を設定する関数となります。

VrComout(“/{FORM DEF Name=name 各属性・・・}/”)

機能署名フィールドを定義します。


int instance.VrComout(“/{FORM DEF Name=name 属性・・・}/”);

Long object.VrComout(“/{FORM DEF Name=name 属性・・・}/”)

int VrComout(HSVFRCLIENT instance, “/{FORM DEF Name=name 属性･･･}/”);

引数 Name 署名フィールド名を指定します（必須）。

RECT 署名フィールドを動的に作成する場合に指定します。

左上の X 座標・Y 座標、右下の X 座標・Y 座標の順番で指

定します（単位：mm）。

例 0|0|50|50

Comment

署名フィールドのコメントを設定します。省略時は””が適用さ

れます。

BC 署名フィールドの枠線色を RGB 値で指定します。

省略時は 0|0|0（黒）が適用されます。

BG 署名フィールドの背景色を RGB 値で指定します。

省略時は 255|255|255（白）が適用されます。

WEIGHT 署名フィールドの枠線の線幅を指定します（単位：ドット）。

省略時は 3 が適用されます。

TYPE 署名フィールド枠線の線種を指定します。

S 実線

D 破線

B ベベル

I 切り込み

U 下線

省略時は S が適用されます。

VIEW PDF 表示時に署名を表示するかを ON または OFF で指定し

ます。省略時は ON が適用されます。

PRINT PDF 印刷時、署名を印刷するかを ON または OFF で指定し

ます。省略時は ON が適用されます。

85


戻り値 0 正常


説明署名フィールドの定義および出力時の設定を、半角スペースを空けて定

義します。この時 NAME 項目は必須となります。その他の項目は、デフォ

ルト値以外の指定をおこないたい場合に定義します。

使用例ビットマップフィールド「Sign」に「PDF に表示する」「署名フィールドの印刷

はしない」と定義します。

svf.VrComout(“/{FORM DEF NAME=Sign VIEW=ON PRINT=OFF}/”);

svf.VrComout(“/{FORM DEF NAME=Sign VIEW=ON PRINT=OFF}/”)

VrComout(svf, “/{FORM DEF NAME=Sign VIEW=ON PRINT=OFF}/”);

この関数は VrSetForm()関数から VrEndPage()関数および VrPrint()関数の間で使用

します。

VrComout("/{FORM OUT NAME=xxx}/”)

機能署名フィールドを作成します。


int instance.VrComout(“/{FORM OUT NAME=Name}/”);

Long object.VrComout(“/{FORM OUT NAME=Name}/”)

int VrComout(HSVFRCLIENT instance, “/{FORM OUT NAME=Name}/”);

引数 NAME 署名フィールドを指定します。

戻り値 0 正常


説明署名フィールドの作成をおこないます。

使用例ビットマップフィールド「Sign」を指定します。

svf.VrComout(“/{FORM OUT NAME=Sign}/”);

86

3 API 関数

svf.VrComout(“/{FORM OUT NAME=Sign}/”)

svf.VrComout(svf, “/{FORM OUT NAME=Sign}/”);


します。

VrComout(“/{SIGN OUT NAME=xxx 各属性・・・}/”)

機能署名情報を出力します。


int instance.VrComout(“/{SIGN OUT NAME=Name 各属性}/”);

Long object.VrComout(“/{SIGN OUT NAME=Name 各属性}/”)

int VrComout(HSVFRCLIENT instance,“/{SIGN OUT NAME=Name 各属性}/”);

引数 NAME 署名フィールドを指定します（必須）。

SLOT SignedPDF Server のスロット番号を指定します。


PASSWORD

SignePDF Server のスロットのパスワードを指定します（必

須）。

PERSON 署名者名を指定します。

省略時は””が適用されます。

CONTACT

署名者連絡先情報を指定します。


LOCATION

署名場所を指定します。


PEASON 署名理由を指定します。


PAGE 署名をおこなうページを指定します。


TRANSCOLOR

印影の透過色を RGB 値で指定します。

省略時は 255|255|255（白）が適用されます。

87


説明 SignedPDF Server とやりとりをおこない署名情報を出力します。

署名情報は、半角スペースで区切って各属性を指定します。この時、

NAME と PASSWORD は必須項目となります。その他の定義については、

デフォルト以外の値を使用したい指定します。

使用例ビットマップフィールド「Sign」に「スロット番号：1」「パスワード：WingArc」の

印影を出力します。

svf.VrComout(“/{FORM OUT NANE=Sign SLOT=1 PASSWORD=WingArc}/”);

svf.VrComout(“/{FORM OUT NANE=Sign SLOT=1 PASSWORD=WingArc}/”)

VrComout(svf,“/{FORM OUT NANE=Sign SLOT=1 PASSWORD=WingArc}/”);


します。

関数使用順

svf.VrInit();

svf.VrSetPrinter(“”, “SignedPDF”);

svf.VrSetSpoolFileName2(“sample.pdf”);


svf.VrComout(“/{FORM DEF NAME=Sign VIEW=ON PRINT=OFF}/”);

svf.VrComout(“/{FORM OUT NAME=Sign}/”);

svf.VrComout(“/{SIGN OUT NAME=Sign SLOT=1 PASSWORD=WingArc}/”);


svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

88

3 API 関数

SVF for Web / Client 使用時の関数

SVF for Web / Client で使用する API 関数は出力データを圧縮する関数のみとなります。

VrComout(“/{SPLM n}/”)

機能出力データファイルの圧縮を指定します。


int instance.VrComout(“/{SPLM n}/”);

Long object.VrComout(“/{SPLM n}/”)

int VrComout(HSVFRCLIENT instance, “/{SPLM n}/”);

引数 n モードの指定

1 プリンタに出力

2 ファイル出力（圧縮しない）

3 ファイル出力（圧縮する）

戻り値 0 成功


説明 SVF for Web/Client を利用している際には、ネットワーク上のデータ転送

の負荷を軽減するために、印刷データを圧縮して作成し、クライアント側

で解凍し印刷をおこないます。このため、かならずファイル出力時に圧縮

する指定をおこないます。ただし、この関数のモードを切り替えることで、

SVF for JavaPrint の環境設定アプレットでプリンタを作成し、IP アドレス

を設定している場合は、直接プリンタに出力することも可能になります。サ

ンプルについては、「SVF for Web/Client ユーザーズ・マニュアル」を参照

してください。

使用例印刷データを圧縮します。

svf.VrComout(“/{SPLM 3}/”);

svf.VrComout(“/{SPLM 3}/”)

VrComout(svf, “/{SPLM 3}/”);

89


90

索引･･････････････････････････････････････････････････････････････････････････････････････････････････････････････････････････

数字

32 ビット型整数 ...............................................11 64 ビット型整数 ...............................................13

Ａ

API 関数 .............................................................5 ASP/COM コネクト............................................3

Ｃ

Chart 機能 ............................................76, 77, 78 CSV 形式 ....................................................50, 81

Ｄ

DATE() .............................................................80

Ｅ

Excel ファイル名指定.......................................76

Ｆ

Fax 送信 ...........................................................83

Ｊ

Java コネクト.....................................................2

Ｍ

MF-P 系 ............................................................63

Ｎ

Null チェック機能 ..............................................1

Ｐ

PAGE() .............................................................25 PC-LASER 系...................................................63

Ｒ

RICOH 製プリンタ .......................................... 63

Ｓ

svf.jar................................................................. 2 svfrclient.dll ...................................................... 3 svfrclient.jar...................................................... 2

Ｔ

TIME()............................................................. 80

Ｖ

VrAdjustd ........................................................ 31 VrAdjustd2 ...................................................... 32 VrAdjustm ....................................................... 31 VrAdjustm2 ..................................................... 32 VrAttribute...................................................... 34 VrAttributen.................................................... 34 VrComout(“/{CGRP BmpField,ChartSheet}/”)... 78 VrComout(“/{EXCL xlsname}/”).................. 76 VrComout(“/{FORM DEF Name=name 各属性・・・}/”) . 85 VrComout(“/{PERM n}/”) ............................ 74 VrComout(“/{PSWD Password}/”)............... 72 VrComout(“/{SDAT gyono,lineno,data}/”) .. 77 VrComout(“/{SECU n}/”) ............................. 71 VrComout(“/{SECUPSWD Password}/”) .... 73 VrComout(“/{SIGN OUT NAME=xxx 各属性・・・}/”) . 87 VrComout(“/{SPLM n}/”)............................. 89 VrComout(“/{SSHT Sheet}/”) ...................... 76 VrComout("/{DATE DateData}/").................... 80 VrComout("/{FORM OUT NAME=xxx}/”) .... 86 VrComout("/{FOUT n}/") ................................. 79 VrCondition..................................................... 23

索引-1

VrCopy .............................................................27 VrEndPage.......................................................16 VrEndRecord....................................................20 VrGetAttribute ................................................41 VrGetFieldCount .............................................51 VrGetFieldLength ...........................................53 VrGetFieldName .............................................52 VrGetFieldRecordType ....................................54 VrGetFieldRepeatCount..................................53 VrGetFieldType ...............................................52 VrGetPageRecordCount ..................................55 VrGetStatus .....................................................50 VrInit..................................................................5 VrInitEx .............................................................5 VriOut ..............................................................11 VriOutn ............................................................11 VrlOut ..............................................................13 VrlOutn ............................................................13 VrOutputQuery................................................50 VrPage..............................................................47 VrPaperEject....................................................45 VrPrint .............................................................21 VrQuit ................................................................6 VrReport...........................................................19 VrrOut..............................................................14 VrrOutn............................................................14 VrSendFaxPress ..............................................83 VrSeqOut .........................................................46 VrSetCalcMode ................................................48 VrSetCSVFileName.........................................81 VrSetDocName2 ..............................................29 VrSetDuplex ....................................................62 VrSetForm .........................................................7 VrSetMachineKind..........................................63 VrSetOutputBin ..............................................64 VrSetPageCount ..............................................25

VrSetPrinter.................................................... 22 VrSetPunch ..................................................... 68 VrSetQuery ..................................................... 17 VrSetSort......................................................... 67 VrSetSpoolFileName2 .................................... 30 VrSetSpoolFileStream .................................... 70 VrSetStaple ..................................................... 66 VrSetTray ........................................................ 60 VrsOut ............................................................. 10 VrsOutn........................................................... 10 VrTest .............................................................. 44

あ

圧縮 .................................................................. 89

い

イメージファイル名出力.................................. 10 印刷開始........................................................... 16 印刷部数指定.................................................... 27 印字位置一時調整 ............................................ 32 印字位置調整.................................................... 31 印字対象ページ ................................................ 47

え

演算ライブラリ ................................................ 80

か

解放 .................................................................... 6

き

基本的なプログラムの流れ ................................ 4 給紙トレイ ....................................................... 60 行数取得........................................................... 55 禁止項目........................................................... 74

索引-2

く

クエリー ...........................................................23 クエリーの実行.................................................19 クエリーファイル指定 ......................................17 グラフ出力........................................................78

し

シーケンシャルモード ......................................46 シート名指定 ....................................................76 十進演算ライブラリ .........................................48 実数 ..................................................................14 出力終了 .............................................................6 出力プリンタ指定 .............................................22 出力モード指定...................................................7 初期化 .................................................................5 署名情報 ...........................................................87 署名フィールド...........................................85, 86

す

ステータス........................................................50 ステープル機能.................................................66

せ

セキュリティ機能 .............................................71 セキュリティパスワード設定 ...........................73 設計関数 ...........................................................25

そ

ソート ...............................................................67

た

対応機種一覧表.................................................56

ち

抽出条件指定.................................................... 23

つ

綴り .................................................................. 47

て

データ変更 ....................................................... 77 テスト印刷 ....................................................... 44

は

排紙先 .............................................................. 64 排出 .................................................................. 45 パスワード設定 ................................................ 72 パンチ機能 ....................................................... 68

ふ

ファイル出力.................................................... 30 ファイル名 ....................................................... 30 フィールド繰り返し数取得 .............................. 53 フィールド桁数取得 ......................................... 53 フィールドの総数 ............................................ 51 フィールドの属性 ...................................... 34, 41 フィールド名取得 ............................................ 52 複数ページ ....................................................... 47 部数 .................................................................. 27 プリンタ........................................................... 22

め

明細レコード.................................................... 20 メモリ出力 ....................................................... 70

も

文字型データ出力 ............................................ 10

索引-3

よ

様式ファイル指定 ...............................................7

り

両面印刷 ...........................................................62

れ

レコード属性取得 ............................................ 54 レポートライターモード.................................. 21

索引-4

Documents

SVF Java PRODUCTS API関数リファレンス･マニュアル · はじめに この度は、SVF Java PRODUCTS（SVF 実行部（Java 版））をお買い上げいただき、誠にあり

SVF Java PRODUCTS API関数リファレンス･マニュアル · はじめにこの度は、SVF Java PRODUCTS（SVF 実行部（Java 版））をお買い上げいただき、誠にあり