svf for .net framework api関数リファレンス・マ …...1 api関数の呼び出し方法 1 1...

はじめに

この度は、SVF for .NET Frameworkをお買い上げいただき、誠にありがとうございます。

SVF for .NET Frameworkは、Microsoft（R）.NET Frameworkで作成するアプリケーション

から、ネイティブな環境で本格的な帳票運用を実現するための帳票出力モジュールです。

固有のプリンタメーカーに依存することなく、.NET Framework対応では業界ではじめて、プ

リンタ機種を選ばずに多様なプリンタへコマンド（プリンタが保有する専用の記述言語）印

刷方式で本格的な帳票印刷を実行することができます。さらに、PDFファイルによる帳票出

力、イメージファイルによる帳票出力が実行できる機能を1つのモジュールのなかにあわせ

て搭載しています。

このマニュアルでは、SVF for .NET Frameworkで使用できるAPI関数について解説してい

ます。

SVF for .NET Framework 対応実行モジュールには、以下の製品が含まれています。

・SVF for .NET Framework

・SVF for .NET Framework/CSV Option

・SVF for .NET Framework/SATO Option

・SVF for .NET Framework/TEC Option

・SVF for .NET Framework/MetaFrame Edition

・Super Visual Formade 設計部 Ver.6.4

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

ii

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

.NET アプリケ－ションからの API 呼び出し .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

.NET アプリケーションから直接呼び出す場合 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

SVF Connect for .NET Framework API を使用して呼び出す場合 ... . . . . . . . . 2

ASP または VB 言語から SVF Connect for ASP/COM API を使用しての呼び出し .... . . . . . . . . 3

C 言語から SVF Connect for ASP/COM API を使用しての呼び出し.... . . . . . . . . . . . . 3

Java から SVF Connect for Java API を使用しての呼び出し .... . . . . . . . . . . . . . . . . . . . . . . . . . 4

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

3 API 関数 6

共通関数-1 ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

VrInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

VrQuit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

VrSetForm .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

VrsOut/VrsOutn .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

VriOut/VriOutn.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

VrlOut/VrlOutn.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

VrrOut/VrrOutn .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

VrEndPage .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

VrSetQuery .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

VrReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

VrEndRecord .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

VrPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

VrSetPrinter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

VrCondit ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

VrSetPageCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

VrCopy .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

VrSetSpoolFi leName2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

VrSetDocName2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

VrAdjustd/VrAdjustm .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

VrAdjustd2/VrAdjustm2 .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

VrAttribute/VrAttributen .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

VrGetAttribute .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

VrTest .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

VrPaperEject .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54

VrSeqOut .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

VrPage .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

VrStack/VrStackOut .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

VrAbortDoc .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

VrSetCalcMode .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

iii

VrGetStatus .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

VrOutputQuery .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

VrDataOut .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

VrSetSpoolFi leStream .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

VrComout("/{SECU n}/") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

VrComout("/{PSWD Password}/") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

VrComout("/{SECUPSWD Password}/") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

VrComout("/{PERM n}/") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72

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

共通関数-2（印刷制御関数） .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

VrSetTray .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

VrSetDuplex .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

VrSetOutputBin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83

VrSetStaple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

VrSetSort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

VrSetPunch .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88

.NET アプリケーションから直接呼出時のみ使用できる関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

VrComout("/{BIND p1 p2 p3}/") （Ver.2.01 から対応）... . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90

VrEnablePreview .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91

VrComout(“/{PPSM mode}/")（Ver.2.1 から対応） ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92

VrEnablePrintBTN（Ver.2.2 から対応）... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93

VrGetAttr ibute(“$PREVIEWUSERSETTINGS$” , Param, Value)（Ver.2.2 から対応） .. . . . .94

VrComout("/{REDU mode type}/")（Ver.2.2 から対応）... . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96

VrEnumPrinters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97

VrGetFieldCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99

VrGetFieldName .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

VrGetFieldType.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

VrGetFieldLength .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

VrGetFieldRepeatCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

VrGetFieldRecordType.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

VrGetPageRecordCount .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

ノータッチデプロイメント機能使用時の関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

VrSmartClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

SVF for .NET Framework/CSV Option 使用時の関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

VrSetCSVFileName.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

コネクト製品からの呼び出し時のみ使用できる関数 .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

VrComout("/{CSMD n}/") （Ver.2.1 から対応） ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

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

VrComout("/SPLM n}/") . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

索引索引-1

1 API 関数の呼び出し方法

1


SVF for .NET Framework が提供する API 関数について説明します。

SVF for .NET Framework を利用して API 関数を呼び出すには、以下の 3 つの方法があ

ります。

・C#.NET や VB.NET で作成した.NET アプリケーションから直接、または SVF Connect

for .NET Framework API を使用しての呼び出し

・ASP、または VB 言語から SVF Connect for ASP/COM API を使用しての呼び出し

・C 言語から SVF Connect for ASP/COM API を使用しての呼び出し

・Java 言語から SVF Connect for Java API を使用しての呼び出し

.NET アプリケーションから API 関数を呼び出すには、.NET アプリケーションから直接、または

SVF Connect for .NET Framework API を使用する方法があります。ここでは、その 2 つの

呼び出し方法について説明します。

.NET アプリケーションから直接呼び出す場合

アセンブリ名 .NET アプリケーションから直接実行する場合には、下記アセンブリを参照

設定してアプリケーションを作成する必要があります。

SVFCS.dl l

動作環境 Microsoft .NET Framework 2.0、3.0、3.5

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

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

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

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

全 API の文字列パラメータに対して Null チェック機能があります。これにより Null 文字列

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

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

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

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

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

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

.NET アプリケ－ションからの API 呼び出し

2

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

「svf」は.NET プログラム内での任意の変数名ですので、ユニークな名前

に変更することが可能です。また、前もって名前空間「jp.co.fit.vfreport」

を宣言してあれば、インスタンス作成時に、これを再度記述する必要はあ

りません。

SVF Connect for .NET Framework API を使用して呼び出す場合

アセンブリ名 SVF Connect for .NET Framework API から実行する場合には、下記ア

センブリを参照設定してアプリケーションを作成する必要があります。

jp.co.fit.Vfreport.SvfrClient.dl l

動作環境 Microsoft .NET Framework 1.1（Ver 7.0）

Microsoft .NET Framework 2.0（Ver 7.1、Ver 8.0）

Microsoft .NET Framework 3.0(Ver 8.0)

Microsoft .NET Framework 3.5（Ver 8.0）

アプリケーション jp.co.fit.Vfreport.SvfrClient.d l l に含まれる jp.co.fit.vfreport.SvfrClient

クラス

説明 jp.co.fit.vfreport.SvfrClient.dl l を使用し、SvfrServer.exe に接続して

SVFCS.dl l の API を実行します。SvfrClient を instance 化することにより

実行が可能になります。

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

「svf」は.NET プログラム内での任意の変数名ですので、ユニークな名前

に変更することが可能です。また、前もって名前空間「jp.co.fit.vfreport」

を宣言してあれば、インスタンス作成時に、これを再度記述する必要はあ

りません。

「hostname」には SVF for .NET Framework がセットアップされているコ

ンピュータの IP アドレス、またはコンピュータ名を文字列として入力します。

SVF for .NET Framework がセットアップされているコンピュータでは、

SvfrServer.exe が起動されている必要があります。

jp.co.fit.vfreport.Vrw32 svf = new jp.co.fit.vfreport.Vrw32();

Dim svf As jp.co.fit.vfreport.Vrw32= New jp.co.fit.vfreport.Vrw32

jp.co.fit.vfreport.SvfrClient svf = new jp.co.fit.vfreport.SvfrClient(hostname);

Dim svf As jp.co.fit.vfreport.SvfrClient = New jp.co.fit.vfreport.SvfrClient(hostname)


3

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

ライブラリ名 svfrcl ient.dl l

動作環境 Windows（詳細は各 Connect 製品のマニュアルを参照してください。）

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

説明 svfrcl ient.dl l を使用し、Svfrserver.exe に接続して SVFCS.dl l の API を

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

能になります。

Svfrcl ient.dl l をコールできるように宣言部を定義します。SVF Connect

for ASP/COM API 製品内に用意されている宣言文のサンプルを参照し

てください。

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





dl l として提供されます。

ライブラリ名 svfrcl ient.dl l

動作環境 Windows（詳細は各 Connect 製品のマニュアルを参照してください。）

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

説明 svfrcl ient.dl l を使用し、Svfrserver.exe に接続して SVFCS.dl l の API を

実行します。接続を Instance 化することにより実行が可能になります。

Svfrcl ient.dl l をコールできるように、 #include 文で定義します。 SVF

Connect for ASP/COM API 製品内に svfrcl ient.h が用意されています

ので、それを利用してください。

instance 生成と、SVF for .NET Framework がセットアップされているコ

ンピュータとの接続は、以下のようにおこないます。





ASP または VB 言語から SVF Connect for ASP/COM API を使用しての呼び出し

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

C 言語から SVF Connect for ASP/COM API を使用しての呼び出し

HSVFRCLIENT svf; svf = VrConnect("hostname");

4

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

ライブラリ名 svfrcl ient.jar

動作環境 JDK1.4.2、または JDK1.5.0（詳細は各 Connect 製品のマニュアルを参照

してください。）

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

説明 svfrcl ient.jar を使用し、Svfrserver.exe に接続して SVFCS.dl l の API を

実行します。接続を Instance 化することにより実行が可能になります。

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

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





Java から SVF Connect for Java API を使用しての呼び出し

import jp.co.fit.vfreport.SvfrClient;

SvfrClient svf = new SvfrClient(hostname);

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

5

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

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

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

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

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

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

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

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

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

6

3 API 関数

SVF for .NET Framework では、使用している製品により、利用可能な関数が異なります。

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

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

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

C#言語およびJava

VB .NET言語

ASPおよびVB言語

C言語

SVF for .NET Framework 製品群内のすべての製品および各コネクト製品において利用

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

VrInit

機能初期化します。

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

共通関数-1

int instance.VrInit(); int instance.VrInit(string Encode);

Function instance.VrInit() As Integer Function instance.VrInit(Encode As String) As Integer

Function instance.VrInit() As Long

int VrInit(HSVFRCLIENT instance);

3 API 関数

7

引数引数には、何も指定しないか、出力時のエンコードを指定します。指定可

能な値は次の通りです。

MS932

UTF-16（PDF、EMF および ImagePrinter 機種出力時のみ）

引数を指定しない場合、および上記以外の文字列が指定された場合は、

MS932 が自動的に設定されます。

また、PDF、EMF および ImagePrinter 機種以外での出力で UTF-16 が

指定された場合は、エラーとなり出力がされません。その際は、VrQuit の

戻り値として、-104 が返されます（プレビューからの印刷の際には、-101

が返されます）。

PDF ファイルを UTF-16 で出力する場合は、フォントの設定が別途必要と

なります。詳細については、「SVF for .NET Framework ユーザーズ・マ

ニュアル」の「SVF for .NET Framework 環境設定」－「機種別基本設

定」－「PDF」の「フォント設定」の説明を参照してください。

戻り値 0 成功

負数エラーステータス

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

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

svf.VrInit(); svf.VrInit(“UTF-16”);

svf.VrInit() svf.VrInit(“UTF-16”)

svf.VrInit()

VrInit(svf);

SVF for .NET FrameworkでのUTF-16出力は、日本語フォント（MS 明朝、MSゴシッ

ク）内のSJIS範囲内にない文字を出力することを目的として実装されています。UTF-16

出力が他国語の出力を可能とするものでないことにご注意ください。

UTF-16のサロゲートペアには対応していません。

UTF-16で出力する場合、SJISで出力する場合と比較して出力されるファイルサイズが

大きくなります。

SVF for .NET Frameworkがサポートしているフォントは等幅フォントのみです。プロポー

ショナルフォントのサポートはしておりませんので、ご注意ください。

8

VrQuit

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


引数なし

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

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

0 印刷処理成功

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


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


int instance.VrQuit();

Function instance.VrQuit() As Integer

Function instance.VrQuit() As Long

int VrQuit(HSVFRCLIENT instance);

svf.VrQuit();

svf.VrQuit()

svf.VrQuit()

VrQuit(svf);

3 API 関数

9

VrSetForm

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


引数 FormName

様式ファイル名

様式ファイルを URL で指定することにより、Web サーバ上に配置

されている様式ファイルを使用することも可能です。

Mode 出力モード

0 シーケンシャルモード

1 ランダムモード

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

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

戻り値 0 成功


ファイル出力時と印刷時で戻り値が異なります。正常終了時の戻り値は、ファイル出力

時にはファイルサイズ、印刷時には「0」となります。異常終了時の戻り値は、ファイル出

力時も印刷時もマイナスの値になりますので、エラーハンドリングをおこなう場合には、マ

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

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

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

です。ただし、アクセス違反など.NET Framework の Exception が発生した場合、その

時点で強制終了されることがあるため、エラーハンドリングができないことがあります。そ

の場合、プロセスが残ってしまうことがあります。コネクト製品を利用している場合は、か

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

増え続けてしまうと、使用しているアプリケーション側で予期せぬエラーが発生すること

があります。

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

Function instance.VrSetForm(FormName As String, Mode As Integer) As Integer

Function instance.VrSetForm(FormName As String, Mode As Long) As Long

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

10

説明 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 レポートライターモード（ソートなし）

クエリーファイルを実行する場合と、データセットからのデータ出力

をする場合（VrDataOut）、サブフォームとレコードが作成されてい

る様式ファイルを使用する場合に設定します。

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

クエリーファイルを実行する場合と、、データセットからのデータ出力

をする場合（VrDataOut）、サブフォームとレコードが作成されてい

る様式ファイルを使用する場合に設定します。このモードを使用し

た時には、様式ファイル上で指定したフィールドのキー順に従って

Super Visual Formade が内部的にデータのソートをおこないます。

3 API 関数

11

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

様式ファイルを URL で指定する場合は以下のように記述します。

関数使用サンプル

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

（C#での実行で 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.VrSetForm("c:¥¥frm¥¥sample.frm",5);

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

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

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

svf.VrSetForm("http://computer/svf/sample.frm",5);

svf.VrSetForm("http://computer/svf/sample.frm",5)

svf.VrSetForm("http://computer/svf/sample.frm",5)

VrSetForm(svf, "http://computer/svf/sample.frm",5);

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

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

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

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

12

svf.VrsOut("shohin_name", "SVF for .NET Framework");

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 レポートライターモードの場合には、すべてのデータ出力終了時に、この関数を呼び出す必要があります。

VrsOut/VrsOutn

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


引数 Field_Name

フィールド名

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

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

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

Function instance.VrsOut(Field_Name As String, data As String) As Integer Function instance.VrsOutn(Field_Name As String, gyo As Integer, data As String) As Integer

Function instance.VrsOut(Field_Name As String, data As String) As Long Function instance.VrsOutn(Field_Name As String, gyo As Long, data As String) As Long

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

3 API 関数

13

戻り値 0 成功


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

データファイル名（パス指定付き）を渡します。Web サーバ上に配置され

ている画像ファイルを URL で指定して使用することも可能です。

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

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

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

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

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

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

ジに渡します。

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

印刷処理が正常におこなわれません。

使用例 ① [会社名]フィールドに「ウイングアークテクノロジーズ株式会社」という

データを渡します。

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

データを渡します。

svf.VrsOut("会社名","ウイングアークテクノロジーズ株式会社");

svf.VrsOut("会社名","ウイングアークテクノロジーズ株式会社")

svf.VrsOut("会社名","ウイングアークテクノロジーズ株式会社")

VrsOut(svf, "会社名","ウイングアークテクノロジーズ株式会社");

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

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

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

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

14

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

VriOut/VriOutn

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


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

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

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

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

SVF for .NET Framework では、出力する SVF 機種により貼りつけられる画像ファイル

の種類が異なります。各 SVF 機種に対応している画像ファイルについては p.75 の「対応

機種一覧表」に記載されている「画像ファイル」欄を参照してください。

int instance.VriOut(string Field_Name, int data); int instance.VriOutn(string Field_Name, int gyo, int data);

Function instance.VriOut(Field_Name As String, data As Integer) As Integer Function instance.VriOutn(Field_Name As String, gyo As Integer, data As Integer) As Integer

Function instance.VriOut(Field_Name As String, data As Long) As Long Function instance.VriOutn(Field_Name As String, gyo As Long, data As Long) As Long

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

3 API 関数

15

引数 Field_Name

フィールド名

gyo 行番号

data 数値型データ

戻り値 0 成功


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

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

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

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

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

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

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

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

Visual Formade 内部で自動的にあふれた行を次ページに渡します。

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

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

svf.VriOut("数量", 100);

svf.VriOut("数量", 100)

svf.VriOut("数量", 100)

VriOut(svf, "数量", 100);

svf.VriOutn("単価", 1, 700000);

svf.VriOutn("単価", 1, 700000)

svf.VriOutn("単価", 1, 700000)

VriOutn(svf, "単価", 1, 700000);

16

VrlOut/VrlOutn

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


引数 Field_Name

フィールド名

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

data データ

戻り値 0 成功


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

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

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

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

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

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

照してください。

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

Function instance.VrlOut(Field_Name As String, data As Long) As Integer Function instance.VrlOutn(Field_Name As String, gyo As Integer, data As Long) As Integer

Function instance.VrlOut(Field_Name As String, data As Long) As Long Function instance.VrlOutn(Field_Name As String, gyo As Long, data As Long) As Long

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

3 API 関数

17

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

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

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

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

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

が初期値となります。

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

設定 ]ダイアログボックスで「自動改ページ」を[する]に指定しておくと、

Super Visual Formade 内部で自動的にあふれた行を次ページに渡します。

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

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

す。

svf.VrlOut("数量", 100);

svf.VrlOut("数量", 100)

svf.VrlOut("数量", 100)

VrlOut(svf, "数量", 100);

svf.VrlOutn("単価", 1, 700000);

svf.VrlOutn("単価", 1, 700000)

svf.VrlOutn("単価", 1, 700000)

VrlOutn(svf, "単価", 1, 700000);








18

VrrOut/VrrOutn

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


引数 Field_Name

フィールド名

gyo 行番号

data データ

戻り値 0 成功


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

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

おこないます。

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

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

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

値となります。

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

設定]ダイアログボックスで[自動改ページ]を[する]に指定しておくと、Super

Visual Formade 内部で自動的にあふれた行を次ページに渡します。

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

Function instance.VrrOut(Field_Name As String, data As Double) As Integer Function instance.VrrOutn(Field_Name As String, gyo As Integer, data As Double) As Integer

Function instance.VrrOut(Field_Name As String, data As Double) As Long Function instance.VrrOutn(Field_Name As String, gyo As Long, data As Double) As Long

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

3 API 関数

19

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

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

svf.VrrOut("数量", 100.00);

svf.VrrOut("数量", 100.00)

svf.VrrOut("数量", 100.00)

svf.VrrOut("数量", 100.00);

svf.VrrOutn("単価", 1, 70.50);

svf.VrrOutn("単価", 1, 70.50)

svf.VrrOutn("単価", 1, 70.50)

svf.VrrOutn("単価", 1, 70.50);








20

VrEndPage

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


引数なし

戻り値 0 成功


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

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

合に有効となります。

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

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

VrEndPage 関数が出力されます。


int instance.VrEndPage();

Function instance.VrEndPage() As Integer

Function instance.VrEndPage() As Long

int VrEndPage(HSVFRCLIENT instance);

svf.VrEndPage();

svf.VrEndPage()

svf.VrEndPage()

svf.VrEndPage();

VrEndPage は、VrSetForm のモードが「4」か「5」の場合、余分なページが出力されてし

まうことがあるため、使用しないでください。

3 API 関数

21

VrSetQuery

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


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

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

Query_File

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

mode 実行モードを指定します。

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

1 SQL 文（SELECT 文のみ）を直接指定できます。

戻り値 0 成功


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

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

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

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

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

Function instance.VrSetQuery(con As String, Query_File As String, mode As Integer) As Integer

Function instance.VrSetQuery(con As String, Query_File As String, mode As Long) As Long

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

svf.VrSetQuery("UID=admin;PWD=password", "c:¥¥test¥¥sample.vrq", 0);

svf.VrSetQuery("UID=admin;PWD=password", "c:¥test¥sample.vrq", 0)

svf.VrSetQuery("UID=admin;PWD=password", "c:¥test¥sample.vrq", 0)

22

svf.VrSetQuery("UID=admin;PWD=password", "c:¥¥test¥¥sample.vrq", 0);

SVF for .NET Framework 内には、ODBC ドライバや ODP.NET、DB2.NET Data

Provider などは含まれていません。

VrSetQuery の引数に URL 指定はできません。

.NET Framework にてデータをアクセスするときに MDAC（Microsoft Data Access

Components）を使用しています。そのため、クエリーファイルを使用するためには MDAC

バージョン 2.8 以降が必要です。

［補足説明］

データベースへの接続方法は、VrSetQuery の第一引数に$KIND パラメータを指定す

ることにより、使用する.NET データ・プロバイダの種類を変更することができます。

-OLEDBプロバイダを使用してクエリー接続する場合

例：VrSetQuery("$KIND=OLEDB;Provider=Microsoft.Jet.OLEDB.4.0;

DataSource=C:\\ProgramFiles\\MicrosoftOffice\\Office\\Samples

\\Northwind.mdb";"VRQファイル名",0)

-SQLCLIENTプロバイダを使用してクエリー接続する場合

例：VrSetQuery("$KIND=SQLCLIENT;server=server; integrated security=

sspi ;database=northwind;uid=WINGARC;pwd=","VRQファイル名",0)

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

「ODBC」として作成します。

-ODP.NETを使用してクエリー接続する場合

例：VrSetQuery("$KIND=ORACLE;UID=scott;PWD=Tiger;DBQ=wingarc","VRQファイル名",0)

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

ず「ORA81」を選択してください。ODP.NETで接続しデータの取得、帳票の作成をおこ

ないます。ODP.NETがインストールできない環境でOracleDBに接続したい場合は、弊社

サポートまでお問い合わせください。

［注意］

・設計はODBCですが、ODBCと他のプロバイダの接続パラメータは大きく異なるため、

各プロバイダ固有の追加パラメータが必要となる場合があります。各プロバイダの資

料を参考に、必要な接続パラメータを追加指定してください。

3 API 関数

23

VrReport

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


引数なし

戻り値 0 成功


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

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

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


int instance.VrReport();

Function instance.VrReport() As Integer

Function instance.VrReport() As Long

int VrReport(HSVFRCLIENT instance);

svf.VrReport();

svf.VrReport()

svf.VrReport()

VrReport(svf);

24

VrEndRecord

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


引数なし

戻り値 0 成功


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

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

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

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

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

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


int instance.VrEndRecord();

Function instance.VrEndRecord() As Integer

Function instance.VrEndRecord() As Long

int VrEndRecord(HSVFRCLIENT instance);

svf.VrEndRecord();

svf.VrEndRecord()

svf.VrEndRecord()

VrEndRecord(svf);

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

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

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

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

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

3 API 関数

25

VrPrint

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


引数なし

戻り値 0 成功


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

印刷する場合と、クエリーや VrDataOut を実行する場合の印刷実行関

数です。


int instance.VrPrint();

Function instance.VrPrint() As Integer

Function instance.VrPrint() As Long

int VrPrint(HSVFRCLIENT instance);

svf.VrPrint();

svf.VrPrint()

svf.VrPrint()

VrPrint(svf);

26

VrSetPrinter

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


引数 PDL SVF 機種

Printer プリンタ名

戻り値 0 成功


説明出力するプリンタ名の指定をおこないます。第二引数[Printer]に環境設

定であらかじめ作成されているプリンタ名を指定した場合、プリンタと

SVF 機種との紐付けは、環境設定のプリンタ設定でおこなわれるため、

第一引数[PDL]は明示的に指定する必要はありません。環境設定での

プリンタの作成方法は利用している SVF for .NET Framework のユー

ザーズ・マニュアルを参照してください。また、ClickOnce およびノータッチ

デプロイメント機能を利用し、SVF for .NET Framework がインストールさ

れていないコンピュータ上で実行する場合、および SVF for .NET

Framework/MetaFrame Edition を使用している場合には、Windows 上

に登録されているプリンタ名を指定します（SVF for .NET Framework が

インストールされているコンピュータ上でも可能）。この場合、第一引数で

SVF 機種が指定されていない場合は、プリンタと SVF 機種との紐付けは、

紐付けファイルを使用しておこなわれます。第一引数で SVF 機種を明示

的に指定しておくと、紐付けファイルを使用しないため、使用する SVF 機

種を確実に決定することが可能になります。

紐付けファイルを使用した印刷処理の流れについては、SVF for .NET

Framework または SVF for .NET Framework/MetaFrame Edition の

ユーザーズ･マニュアルを参照してください。

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

Function instance.VrSetPrinter(PDL As String, Printer As String) As Integer

Function instance.VrSetPrinter(PDL As String, Printer As String) As Long

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

3 API 関数

27

使用例 [PDF]という名前の SVF for .NET Framework 環境設定上のプリンタに

出力をおこないます。

Windows 上の[RICOH IPSiO NX920]という名前のプリンタに出力をおこ

ないます（SVF 機種の決定は紐付けファイルを使用しておこなわれま

す）。

Windows 上の[RICOH IPSiO NX920]という名前のプリンタに SVF 機種

[RPDL2]を指定して出力をおこないます。

svf.VrSetPrinter( "", "PDF");

svf.VrSetPrinter( "", "PDF")

svf.VrSetPrinter( "", "PDF")

VrPrint(svf, "", "PDF");

svf.VrSetPrinter( "", "RICOH IPSiO NX920");

svf.VrSetPrinter( "", "RICOH IPSiO NX920")

svf.VrSetPrinter( "", "RICOH IPSiO NX920")

VrPrint(svf, "", "RICOH IPSiO NX920");

svf.VrSetPrinter( "RPDL2", "RICOH IPSiO NX920");

svf.VrSetPrinter( "RPDL2", "RICOH IPSiO NX920")

svf.VrSetPrinter( "RPDL2", "RICOH IPSiO NX920")

VrPrint(svf, "RPDL2", "RICOH IPSiO NX920");

28

関数使用順

svf.VrInit();


svf.VrSetSpooleFileName2("sample.pdf");

svf.VrSetForm("sample.frm", 5);

svf.VrsOut("field", "data");

svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

≪指定可能な第一引数≫

第一引数としての指定名備考

Adobe PostScript POSTSCRIPT

Canon LIPS3 LIPS3

Canon LIPS4 LIPS4

EPSON ESC/Page ESCPAGE

ESCP DotPrinterESCP

ESCP（Image） DotPrinterESCPi

FUJIXEROX ART4 ART4

FUJIXEROX DP Series DP300

FUJITSU VSP VSP

Hewlett-Packard PCL5 PCL5

IBM5577 DotPrinterIBM5577

IBM5577（Image） DotPrinterIBM5577i

ImagePrinter ImagePrinter

KYOCERA MITA PRESCRIBE2 PRESCRIBE2

NEC NPDL2 NPDL2

PR201 DotPrinterPR201

PR201（Image） DotPrinterPR201i

RICOH RPCS RPCS

RICOH RPDL2 RPDL2

UNISYS JPP JPP

SATO ※ SATO 機種を指定することはできません。別途 SVF for .NET Framework/SATO Option が必要です。

TEC TECB474 別途 SVF for .NET Framework/TEC Option が必要です。

VrSetPrinter 関数は VrInit 関数の直後に利用してください。その他の関数を利用した後で

実行すると、VrInit 関数と VrSetPrinter 関数の間に呼び出された関数はクリアされます。関

数の使用順については、次の「関数使用順」欄を参照してください。

PDF、CSV、EMF ファイル出力の場合は、かならず SVF for .NET Framework 環境設定でプ

リンタ追加をおこなってください（PDF はデフォルトで追加されています）。プリンタ追加の詳細

については、SVF for .NET Framework ユーザーズ･マニュアルを参照してください。

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

を参照してください。

3 API 関数

29

VrCondition

機能クエリーの抽出条件を指定します。


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

mode モード

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

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

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

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

条件式に戻します。

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

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

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

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

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

戻り値 0 成功


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

があります。

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

int instance.VrCondition(string pic, int mode);

Function instance.VrCondition(pic As String, mode As Integer) As Integer

Function instance.VrCondition(pic As String, mode As Long) As Long

int VrCondition(HSVFRCLIENT instance, Char *pic, int mode);

svf.VrCondition( "", 0);

svf.VrCondition( "", 0)

svf.VrCondition( "", 0)

VrCondition(svf, "", 0);

30

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

svf.VrInit();


svf.VrSetSpoolFile2( "sample.pdf");

svf.VrSetForm( "sample.frm", 4);

svf.VrSetQuery( "UID=WingArc;PWD=WingArc", "sample.vrq", 0);

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.VrSetSpoolFileName2( " sample.pdf");

svf.VrSetForm( "sample.pdf", 5);

svf.VrSetQuery( "UID=WingArc;PWD=WingArc", "sample.vrq", 0);

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

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

svf.VrReport();

svf.VrPrint();

svf.VrQuit();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

してください。

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

いた[’明細 ’]をテーブル名として指定します。

3 API 関数

31

VrSetPageCount

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


引数 no PAGE の初期値

add PAGE の加算値

戻り値 0 成功


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

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

VrInit 関数および VrSetForm 関数が実行されると、初期値と加算値が

「1」にセットされます。

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

指定します。

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

Function instance.VrSetPageCount(no As Integer, add As Integer) As Integer

Function instance.VrSetPageCount(no As Long, add As Long) As Long

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

svf.VrSetPageCount( 5, 1);

svf.VrSetPageCount( 5, 1)

svf.VrSetPageCount( 5, 1)

VrCondition(svf, 5, 1);

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

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

32

関数使用順

svf.VrInit();




svf.VrsOut( "field", "data");

svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

関数使用順：応用

（C#で 2 つの帳票を使用し、ページを連番で取得する場合）

StringBuilder sb = new StringBuilder();

svf.VrInit();


svf.VrSetForm( "sample1.frm", 5);


svf.VrEndRecord();

svf.VrPrint();

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

String page_no1 = sb.ToString();← StringBuilder から String 変換

int page_cnt1 = Int.Parse(page_no1);← 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 関数を参照してください。



3 API 関数

33

VrCopy

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


引数 n 部数

戻り値 0 成功


説明同一ページを指定した部数出力します。この関数を利用しない場合は、

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

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

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

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

int instance.VrCopy(int n);

Function instance.VrCopy(n As Integer) As Integer

Function instance.VrCopy(n As Long) As Long

int VrCopy(HSVFRCLIENT instance, int n);

svf.VrCopy( 3);

svf.VrCopy( 3)

svf.VrCopy( 3)

VrCopy(svf, 3);

34

関数使用順

svf.VrInit();

svf.VrSetPrinter( "", "printer");



svf.VrCopy( 3);


svf.VrEndPage();

svf.VrQuit();

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

VrSetSpoolFileName2

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

定します。


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

戻り値 0 成功


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

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

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

・［ESC／PAGE や RPDL2 等のページ記述言語（PDL）で出力している場合］

プリンタ実機のパネルでステータスシートを出力し「コピー枚数」や「印刷部数」など

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

ます。

int instance.VrSetSpoolFileName2(string FileName);

Function instance.VrSetSpoolFileName2(FileName As String) As Integer

Function instance.VrSetSpoolFileName2(FileName As String) As Long

int VrSetSpoolFileName2(HSVFRCLIENT instance, Char *FileName);

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

参照してください。

3 API 関数

35

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

VrSetSpoolFi leName2 関数を使用しない場合は、 SVF for .NET

Framework 環境設定で指定されているプリンタの［出力ディレクトリ］欄

で指定されているパスへファイルが作成されます。

使用例 c:\svf の下に「sample.pdf」を作成します。

関数使用順

svf.VrInit();


svf.VrSetSpoolFileName2("c:¥¥svf¥¥sample.pdf");


svf.VrsOut("Field", "data");

svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

svf.VrSetSpoolFileName2("c:¥¥svf¥¥sample.pdf")

svf.VrSetSpoolFileName2("c:¥svf¥sample.pdf")

svf.VrSetSpoolFileName2("c:¥svf¥sample.pdf")

VrSetSpoolFileName2(svf, "c:¥¥svf¥¥sample.pdf");

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

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

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

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

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

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

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

SVF Connect for .NET API、SVF Connect for ASP/COM API、および SVF Connect for

Java API から実行する場合は、作成されたファイルをデフォルトの動作では、呼び出し元

であるアプリケーションサーバに戻します（SVF 関連製品がセットアップされているコン

ピュータに PDF を出力したい場合は、VrComout("/{CSMD n}/")関数を使用する必要が

あります。詳細については、p.105「VrComout("/{CSMD n}/")」関数の項を参照してくださ

い）。このため、ファイルの保存先は、アプリケーションサーバからのパスを指定する必要が

あります。この時、様式ファイル名やクエリーファイル名の指定は、ファイル生成をおこなう

SVF 関連製品がセットアップされているコンピュータから見たパスを指定してください。



36

VrSetDocName2

機能 Windows のスプーラに書き込む際の文書名を指定します。


引数 docName 文書名

戻り値 0 成功


説明 Windows にスプールする際の文書名を指定します。また PDF 文書のプロ

パティでタイトルを指定します。

使用例 Windows のスプーラに書き込む際の文書名を「売上伝票＿ウイングアー

クテクノロジーズ」と指定します。

関数使用順 svf.VrInit();

svf.VrSetPrinter( "", "RPCS"); svf.VrSetDocName2("売上伝票＿ウイングアークテクノロジーズ"); svf.VrSetForm("sample.frm", 5); svf.VrsOut("Field", "data"); svf.VrEndRecord(); svf.VrPrint();

svf.VrQuit();

int instance.VrSetDocName2（string docName）;

Function instance.VrSetDocName2(docName As String) As Integer

Function instance.VrSetDocName2(docName As String) As Long

int VrSetDocName2(HSVFRCLIENT instance, Char *docName);

svf.VrSetDocName2("売上伝票＿ウイングアークテクノロジーズ");

svf.VrSetDocName2("売上伝票＿ウイングアークテクノロジーズ")

svf.VrSetDocName2("売上伝票＿ウイングアークテクノロジーズ")

VrSetDocName2(svf, "売上伝票＿ウイングアークテクノロジーズ");

この部分は「基本的なプ

ログラムの流れ」を参照

してください。

3 API 関数

37

VrAdjustd/VrAdjustm

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


引数 Form 様式ファイル名

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

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

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

VrAdjustd の場合

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

VrAdjustm の場合

1/10 ミリ

戻り値 0 成功


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

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

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

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

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

ImagePrinter 機種（イメージ印刷）を使用して印刷する場合には、VrSetDocName2 関

数での指定は有効になりません。

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

Function instance.VrAdjustd(Form As String, x As Integer, y As Integer) As Integer Function instance.VrAdjustm(Form As String, x As Integer, y As Integer) As Integer

Function instance.VrAdjustd(Form As String, x As Long, y As Long) As Long Function instance.VrAdjustm(Form As String, x As Long, y As Long) As Long

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

38

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

ます。

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

svf.VrAdjustd("c:¥¥svf¥¥sample.frm",-40, 20);

svf.VrAdjustd("c:¥svf¥sample.frm",-40, 20)

svf.VrAdjustd("c:¥svf¥sample.frm",-40, 20)

VrAdjustd(svf, "c:¥¥svf¥¥sample.frm",-40, 20);

svf.VrAdjustm("c:¥¥svf¥¥sample.frm",-40, 20);

svf.VrAdjustm("c:¥svf¥sample.frm",-40, 20)

svf.VrAdjustm("c:¥svf¥sample.frm",-40, 20)

VrAdjustm(svf, "c:¥¥svf¥¥sample.frm",-40, 20);

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

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

3 API 関数

39

VrAdjustd2/VrAdjustm2

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


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

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

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

VrAdjustd2 の場合

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

VrAdjustm2 の場合

1/10 ミリ

戻り値 0 成功


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

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

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

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

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

使用例 ① 印字位置を一時的に左に 40 ドット、下に 20 ドット移動します。

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

Function instance.VrAdjustd2(x As Integer, y As Integer) As Integer Function instance.VrAdjustdm2(x As Integer, y As Integer) As Integer

Function instance.VrAdjustd2(x As Long, y As Long) As Long Function instance.VrAdjustdm2(x As Long, y As Long) As Long

int VrAdjustd2(HSVFRCLIENT instance, int x, int y); int VrAdjustm2(HSVFRCLIENT instance, int x, int y);

svf.VrAdjustd2(-40, 20);

svf.VrAdjustd2(-40, 20)

40

② 印字位置を左に 4 ミリ、下に 2 ミリ移動します。

svf.VrAdjustd2(-40, 20)

VrAdjustd2(svf,-40, 20);

svf.VrAdjustm2(-40, 20);

svf.VrAdjustm2(-40, 20)

svf.VrAdjustm2(-40, 20)

VrAdjustm2(svf,-40, 20);

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

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

3 API 関数

41

VrAttribute/VrAttributen

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


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

gyo 行番号

Data 変更データ

戻り値 0 成功


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

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

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

指定します。

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

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

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

が実行されます。

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

Function instance.VrAttribute(Field As String, Data As String) As Integer Function instance.VrAttributen(Field As String, gyo As Integer, Data As String) As Integer

Function instance.VrAttribute(Field As String, Data As String) As Long Function instance.VrAttributen(Field As String, gyo As Long, Data As String) As Long

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

42

項目名記述指定内容

開始 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:する

イタリック 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:する

3 API 関数

43

項目名記述指定内容

アンダーライン 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=打ち消し線

フィールド色 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 のレポートライターモードで

は使用できません。

44

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

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

② [ 金額 ] フィールドの計算式を「数量 * 単価」、編集式を

「FORMAT(金額,"ZZZ9")」に変更します。

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

svf.VrAttribute("会社名","ZenFont=1,Size=10.8,TateBai=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=1,Size=10.8,TateBai=3.0");

svf.VrAttribute(" 金額 ","Calc= 単価 * 数量 ,Edit=FORMAT( 金

額,"ZZZ9")");

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

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

VrAttribute(svf, " 金額 ","Calc= 単価 * 数量 ,Edit=FORMAT( 金

額,"ZZZ9")");

svf.VrAttributen("品名", 1, "Bold=1");

svf.VrAttributen ("品名", 1, "Bold=1")

svf.VrAttributen ("品名", 1, "Bold=1")

VrAttributen(svf, "品名", 1, "Bold=1");

3 API 関数

45

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

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

印字しません。

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

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

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

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

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

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

svf.VrAttribute("金額", "Tsuzuri=01100")

svf.VrAttribute("金額", "Tsuzuri=01100")

VrAttribute(svf, "金額", "Tsuzuri=01100");

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

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

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

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

46

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

会社名

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

会社名

⑦ [明細 ]レコードの中のすべてのフィールドが初期値（データがない）

場合には印刷しません。

⑧ [得意先コード]フィールドの内容が変化すると改ページをおこないま

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

ブ画面での設定よりも優先されます。

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

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

svf.VrAttribute( "明細", "Print=2")

svf.VrAttribute("明細", "Print=2")

VrAttribute(svf, "明細", "Print=2");

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

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

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

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

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

3 API 関数

47

⑩ [売上月 ]フィールドが変化すると改ページし、C:\svf\banner.frm

を挿入します。

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

ます。

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

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

svf.VrAttribute( "金額", "Print=0")

svf.VrAttribute( "金額", "Print=0")

VrAttribute(svf, "金額", "Print=0");

svf.VrAttribute("売上月","BANNER=C:¥¥svf¥¥banner.frm");

svf.VrAttribute("売上月","BANNER=C:¥svf¥banner.frm")

svf.VrAttribute("売上月","BANNER=C:¥svf¥banner.frm")

VrAttribute(svf, "売上月","BANNER=C:¥¥svf¥¥banner.frm");

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

svf.VrAttribute("売上月", "ORDER=1") svf.VrAttribute("売上日", "ORDER=-2")

svf.VrAttribute("売上月", "ORDER=1") svf.VrAttribute("売上日", "ORDER=-2")

VrAttribute(svf, "売上月", "ORDER=1"): VrAttribute(svf, "売上日", "ORDER=-2"):

48

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

を印字します。

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

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

出力します。挿入レコードは、Null（例 "BLANK="）をセットすると解除

されます。

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

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

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

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

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

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

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

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

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

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

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

ます。

クエリーから実行がおこなわれている場合、VrDataOut 関数を使用している際にはデー

タを発行する Vr?Out 関数と VrEndRecord 関数を内部的に発行しているため、指定す

る内容によっては、一番はじめに出力されるレコードにのみ設定が有効となる場合があり

ます。

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

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

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

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

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

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

3 API 関数

49

VrGetAttribute

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


引数 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

int instance.VrGetAttribute(string Field, string Komoku, System. Text.StringBuilder Data);

Function instance.VrGetAttribute(Field As String, Komoku As String, Data As System.Text.StringBuilder) As Integer

Function instance.VrGetAttribute(Field As String, Komoku As String, Data As String) As Long

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

50

項目名記述取得内容

明度 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:する

総ページ数 TotalPageCount 総ページ数

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

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

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

svf.VrGetAttribute( "単価", "ZenFont", Data);

svf.VrGetAttribute( "単価", "ZenFont", Data)

svf.VrGetAttribute( "単価", "ZenFont", Data)

VrGetAttribute(svf, "単価", "ZenFont", Data);

3 API 関数

51

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

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

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

svf.VrGetAttribute( "金額", "Calc", Data);

svf.VrGetAttribute( "金額", "Calc", Data)

svf.VrGetAttribute( "金額", "Calc", Data)

VrGetAttribute(svf, "金額", "Calc", Data);

svf.VrGetAttribute( "", "TotalPageCount", Buff);

svf.VrGetAttribute( "", "TotalPageCount", Buff)

svf.VrGetAttribute( "", "TotalPageCount", Buff)

VrGetAttribute(svf, "", "TotalPageCount", Buff);

svf.VrGetAttribute("$SPOOLFILENAME$","",Buff);

svf.VrGetAttribute("$SPOOLFILENAME$","",Buff)

svf.VrGetAttribute("$SPOOLFILENAME$","",Buff)

VrGetAttribute(svf, "$SPOOLFILENAME$","",Buff);

52

VrTest

機能テスト印刷を実行します。


引数なし

戻り値 0 成功


説明 VrSetForm 関数で定義した様式ファイルのテスト印刷を実行します。


ASP 言語を利用している場合、ASP 上で定義する変数に明確な型が存在しないた

め、型変換がおこなえません。このため、VrGetAttribute 関数は使用できません。

VrGetAttribute 関数でフィールドの属性を取得する場合に、言語によっては、変数定

義時に Buffer エリアを取っていないとアプリケーションエラーが発生する場合があります。

VB 言語を利用している場合は、「Dim szBuffer as String * 256」というような形で指

定してください。Java の場合には、StringBuffer を利用してください。

サブフォームとレコードが設計されている様式を利用しての出力、またはクエリーファイル

を利用しての出力をおこなう場合、"TotalPageCount"および"$SPOOLFILENAME$"は

VrPrint 関数を発行した後に実行してください。

SVF Connect for .NET Framework API、SVF Connect for Java API・SVF Connect

for ASP/COM API から利用する場合、"$SPOOLFILENAME$"で取得されるファイル名

は一時ファイル名となります。

ファイルを生成するコンピュータは、一時ファイルを作成後、呼び出し元のアプリケーショ

ンサーバ側へ戻します。つまり"$SPOOLFILENAME$"でファイル名を取得する際に生成

されているファイルが一時ファイルのみとなっているため、取得できる値が一時ファイル

名となります。

"X""Y"ではフィールドの座標を取得することは可能ですが、サブフォームやレコードなどの

アイテムの座標を取得することはできません。

int instance.VrTest();

Function instance.VrTest() As Integer

Function instance.VrTest() As Long

int VrTest(HSVFRCLIENT instance);

svf.VrTest();

3 API 関数

53

関数使用順

svf.VrInit();

svf.VrSetPrinter( "", "printer");


svf.VrTest();

svf.VrEndPage();

svf.VrQuit();

svf.VrTest()

svf.VrTest()

VrTest(svf);

VrTest 関数は、設計部の[印刷]メニューの[テスト印刷]で[簡易印刷]モードを設定し

て実行する時と同様の出力結果となります。

VrTest 関数を使用する場合は、様式ファイルの中にサブフォームとレコードが設計され

ているフォームでも VrSetForm 関数の Mode はかならず「1」としてください。

54

VrPaperEject

機能プリンタ内部に残っている用紙を排出します。


引数なし

戻り値 0 成功


説明両面印刷実行時に、奇数ページで印刷が終了すると、プリンタ内部に最

終ページが残ります。印刷終了時にこの関数を実行すると、最終ページ

が自動的に排出されます。

また、連写機能を使用した様式ファイルを実行する場合、1 ページ内の

すべての連写アイテムに満たない数で最終ページが終了した場合にも、

VrPaperEject 関数でページの排出が可能です。


int instance.VrPaperEject();

Function instance.VrPaperEject() As Integer

Function instance.VrPaperEject() As Long

int VrPaperEject(HSVFRCLIENT instance);

svf.VrPaperEject();

svf.VrPaperEject()

svf.VrPaperEject()

VrPaperEject(svf);

PostScript ・ FujiXeroxDPSeries ・ UNISYS JPP を利用して出力する場合には、

VrPaperEject 関数が発行されても有効になりません。

両面印刷で片面印刷終了時の排出処理については、プリンタの機種により機能しない

場合があります。

3 API 関数

55

VrSeqOut

機能シーケンシャルモードでの文字列を出力します。


引数 Data データ

戻り値 0 成功


説明 VrSetForm 関数によって定義する出力モードがシーケンシャル

（Mode=0）の場合、VrSeqOut 関数でデータをフィールドの設計されてい

る座標順（左上から右下）に出力します。出力できるデータは文字列に

限ります。基本は SVF 内部で保有するバッファ順に格納されます。通常

は上から順で、繰り返し行であっても優先されません。

4XXX 3XX

4RRR

と様式に設計した場合

VrSeqOut(h, "0001")

VrSeqOut(h, "002")

VrSeqOut(h, "0003")

の順に出力すると

0001 002

0003

と出力します。

使用例文字列「Data」をフィールドに送ります。

int instance.VrSeqOut(string Data);

Function instance.VrSeqOut(Data As String) As Integer

Function instance.VrSeqOut(Data As String) As Long

int VrSeqOut(HSVFRCLIENT instance, Char *Data);

svf.VrSeqOut( "Data");

svf.VrSeqOut( "Data")

svf.VrSeqOut( "Data")

56

関数使用順

svf.VrInit();

svf.VrSetPrinter( "", printer);


svf.VrSeqOut( "Data1");

svf.VrSeqOut( "Data2");

：

svf.VrEndPage();

svf.VrQuit();

VrPage

機能綴りが複数ページで構成されている様式の印字対象ページを指定します。


引数 Page 1 印字するページ

0 印字しないページ

戻り値 0 正常


説明様式ファイル設計上の[ページの基本設定]ダイアログボックスで、「綴り」

ページを「2」以上に設定していて、かつ、綴りページをページごとに印字す

るかどうかを指定したい場合に利用します。

VrPage 関数が発行されない場合には、すべての綴りページが出力され

ます。一度印字対象ページを指定すると、次に異なるページを指定する

か、VrSetForm 関数によって新しい様式ファイルが指定されるまで有効

となります。

VrSeqOut(svf, "Data");

int instance.VrPage(string Page);

Function instance.VrPage(Page As String) As Integer

Function instance.VrPage(Page As String) As Long

int VrPage(HSVFRCLIENT instance, Char *Page);

3 API 関数

57

使用例綴りページが「5」の際に、綴りページの 1,2,5 ページを印字し、3,4 は印字し

ません。

関数使用順

svf.VrInit();

svf.VrSetPriniter( "", printer);


svf.VrPage( "11001");

svf.VrsOut( "Field", "Data");

svf.VrEndPage();

svf.VrQuit();

svf.VrPage( "11001");

svf.VrPage( "11001")

svf.VrPage( "11001")

VrPage(svf, "11001");

ドットプリンタに出力をおこなう場合には、綴りページの設定自身が無効となるため、

VrPage 関数がコールされても有効にはなりません。

58

VrStack/VrStackOut

機能両関数の間で出力される綴り指定の様式ファイルをスタック印刷します。


引数なし

戻り値 0 正常


説明様式ファイル設計上の[ページの基本設定]ダイアログボックスで、「綴り」

ページを「２」以上に設定していて、スタック印刷（綴りページごと）する場

合に使用します。VrStack 関数で印刷モードを設定し、VrStackOut 関

数が出力されるまで出力データはプリンタに出力されず、スタックファイル

に記録されます。VrStackOut 関数が発行されるとスタックファイルに記

録されている印刷データを綴りページごとにプリンタに出力し、印刷を終

了するとスタックモードを終了します。

使用例綴り指定の様式ファイルをスタック印刷します。

int instance.VrStack(); int instance.VrStackOut();

Function instance.VrStack() As Integer Function instance.VrStackOut() As Integer

Function instance.VrStack() As Long Function instance.VrStackOut() As Long

int VrStack(HSVFRCLIENT instance); int VrStackOut(HSVFRCLIENT instance);

svf.VrStack(); svf.VrStackOut();

svf.VrStack() svf.VrStackOut()

svf.VrStack() svf.VrStackOut()

3 API 関数

59

関数使用順

svf.VrInit();



↑綴りページ「２」以上の様式ファイルを設定

svf.VrStack()

↑スタックの開始


：

svf.VrEndPage();


：

svf.VrEndPage();

svf.VrStackOut();

↑スタックファイルから印刷を開始

svf.VrQuit();

VrStack(svf); VrStackOut(svf);

スタック印刷とプレビューは併用できません。スタック印刷をする場合にはプレビューせ

ずに印刷してください。

出力できるページ数は 999 ページまでです。

ハードディスクにスタックファイルを作成しているため、ハードディスクの空き容量には充

分注意してください。

この関数は綴りで設計された様式ファイルに対してのスタック機能です。様式ファイル

中の書式定義での部数指定や、VrCopy 関数を使用した部数指定での複数ページ出

力では、この関数でスタック印刷はできません。

スタック印刷は 1 様式が対象です。

複数の様式が混在する場合やレポートライターモードでの動作は保証できません。

60

VrAbortDoc

機能印刷を中止します。


引数なし

戻り値 0 正常



関数使用順

svf.VrInit();




：

svf.VrEndPage();


：

svf.VrEndPage();

svf.VrAbortDoc();

svf.VrQuit();

int instance.VrAbortDoc();

Function instance.VrAbortDoc() As Integer

Function instance.VrAbortDoc() As Long

int VrAbortDoc(HSVFRCLIENT instance);

svf.VrAbortDoc();

svf.VrAbortDoc()

svf.VrAbortDoc()

VrAbortDoc(svf);

3 API 関数

61

VrSetCalcMode

機能最大 29 桁（整数部＋小数部）の十進演算ライブラリをサポートします。


引数 Mode 演算動作設定

0 DOUBLE 型演算（デフォルト）

1 多倍精度十進浮動小数点型演算

戻り値 0 成功


説明 15 桁以上の数値データを扱う場合に使用します。この関数を使用して

多倍精度十進浮動小数点型演算を指定すると、数値データを 33 桁ま

で出力することができます。この関数による指定がない場合には、

svf.cs.properties ファイルの設定に従います。svf.cs.properties ファイル

の設定については、以下を参照してください。


VrAbortDoc()の直後には VrQuit()を発行する必要があります。

int instance.VrSetCalcMode(int Mode);

Function instance.VrSetCalcMode(Mode As Integer) As Integer

Function instance.VrSetCalcMode(Mode As Long) As Long

int VrSetCalcMode(HSVFRCLIENT instance, int Mode);

svf.VrSetCalcMode(1);

svf.VrSetCalcMode(1)

svf.VrSetCalcMode(1)

VrSetCalcMode(svf, 1);

62

関数使用順

svf.VrInit();

svf.VrSetCalcMode( 1);




svf.VrEndPage();

svf.VrQuit();

演算結果が最大有効桁数を超えた場合は、最下位桁が切り捨てられます。

また演算途中で最大有効桁数を超えた場合も、その時点の結果の最下位桁が切り

捨てられます。

多倍精度十進浮動小数点型演算を利用する場合には、数値型フィールドに対して数

値データを出力する関数として VrsOut/VrsOutn 関数を利用し、数値データを文字列

データとして出力してください。

svf.cs.properties ファイルを変更する場合は、以下の設定箇所以外は変更しないでくださ

い。他部分を変更すると SVF for .NET Framework の動作が変わってしまう場合がありま

す。そのような場合には、サポート範囲外となる可能性もありますので、ご了承ください。

≪svf.cs.properties の設定方法≫

1 SVF for .NET Framework セットアップフォルダの中の「.\SVFdNP\properties」下にあ

る svf.cs.properties ファイルをテキストエディタで開きます。

2 以下の設定内容を、次のように変更して、上書き保存します。

変更前 Fcl ib.UseMPL=False

↓

変更後 Fcl ib.UseMPL=True

この部分は「基本的なプログラム

の流れ」を参照してください。

3 API 関数

63

VrGetStatus

機能ステータスを取得します。


引数なし

戻り値 0 正常


説明戻り値に、この関数の前に実行された関数の実行結果を戻します。

VrOutputQuery

機能 VrSetQuery 関数で指定したクエリーを実行した際にデータベースから取

得されたデータを、指定したファイルに CSV 形式で保存します。


引数 Fi leName 保存する CSV ファイル名をフルパスで指定します。

戻り値 0 成功


int instance.VrGetStatus();

Function instance.VrGetStatus() As Integer

Function instance.VrGetStatus() As Long

int VrGetStatus(HSVFRCLIENT instance);

int instance.VrOutputQuery(string FileName);

Function instance.VrOutputQuery(FileName As String) As Integer

Function instance.VrOutputQuery(FileName As String) As Long

int VrOutputQuery(HSVFRCLIENT instance, Char *FileName);

64

説明 VrSetQuery 関数で実行をおこなうクエリーファイルの内容に従ってデー

タベースから取得した内容を、CSV 形式（カンマ区切り）のファイルとして

出力します。


関数使用順

svf.VrInit();



svf.VrSetQuery( "UID=xxx;PWD=xxx", "sample.vrq", 0);

svf.VrOutputQuery( "data.csv");

svf.VrReport();

svf.VrPrint();

svf.VrQuit();

svf.VrOutputQuery("c:¥¥svf¥¥data.csv");

svf.VrOutputQuery("c:¥svf¥data.csv")

svf.VrOutputQuery("c:¥svf¥data.csv")

VrOutputQuery(svf, "c:¥¥svf¥¥data.csv");

VrOutputQuery 関数は、データベースから取得したデータを CSV に出力する関数で

す。様式ファイル内に設定してある編集式や計算式は適用されません。編集式や計算

式を反映した形で CSV ファイルを出力したい場合は、別途 SVF for .NET

Framework/CSV Option を利用してください。

3 API 関数

65

VrDataOut

機能 DataSet 内のテーブルデータを一括で出力します。


引数 source テーブル

戻り値 0 正常終了

-544 データ（行）が 1 行もありませんでした

-555 印刷フィールド名と一致するデータ（列）名が存在しませんでし

た。

-4971 処理中に例外が発生しました。

C#での関数使用順

using System;

namespace Sample

{

///<summary>

/ *

* VrDataOut を使うサンプルコードです。

*

* 本プログラムコードはサンプルとして提供するものです。

* サンプルとしての理解しやすさを主眼としているため、エラーハンドリング、

* 動作に関する効率、メンテナンス性、セキュリティ、同時実行性、負荷への

* 耐久性などに関しては考慮しておりません。

* また、弊社では、このコードを使用した事による、いかなる損害、被害について

* 責を負わないものとします。

int instance.VrDataOut(System.Data.DataTable source); int instance.VrDataOut(System.Data.DataView source);

Function instance.VrDataOut(source As System.Data.DataTable) As Integer Function instance.VrDataOut(source As System.Data.DataView) As Integer

コネクト経由で使用する場合は、SVF Connect for .NET Framework API でのみ利用

できます。SVF Connect for ASP/COM API、SVF Connect for Java API では使用で

きません。

一回の帳票レイアウト処理中に引き渡せるテーブル数は 1 つです。

DataSet のテーブルのカラム名と、SVF 設計部で作成する frm ファイル内のフィールド

名が一致している必要があります。

66

* お客様の方で内容を吟味した上でご使用ください。

*

* Copyright (C) 2006 WingArc Technologies, Inc.

*/

///</summary>

public class VrDataOut

{

[STAThread]

public static void Main(String[] args)

{

now vrDataOut().Test();

}

public VrDataOut()

{

}

public void Test()

{

//

// この例は "C:¥Program Files¥Microsoft Office¥Office¥Samples¥Northwind.mdb" を使っていま

す。

//

string tableName = "受注";

string connectionString = "DSN=MSAccess Database";

string selectCommandText = "SELECT * FROM" + tableName;

System.Data.IdbDataAdapter dbDataAdapter =

new System.Data.Odbc.OdbcDataAdapter(selectCommandText, connectionString);

System.Data.DataSet dataset = new System.Data.DataSet();

dbDataAdapter.Fill(dataset);

//

//SVF で印刷実行

//

jp.co.fit.vfreport.Vrw32 svf = new jp.co.fit.vfreport.Vrw32();

svf.VrInit();


svf.VrSetSpoolFileName2("C:¥¥MyProducts¥¥dotnet¥¥cs¥¥SVFdNet¥¥Sample¥¥Northwind.pdf");

svf.VrSetForm("C:¥¥MyProducts¥¥dotnet¥¥cs¥¥SVFdNet¥¥Sample¥¥Northwind.frm", 5);

svf.VrDataOut(dataset.Tables[0]);

svf.VrPrint();

svf.VrQuit();

}

}

}

3 API 関数

67

VrSetSpoolFileStream

機能ファイル生成時にディスク上のファイルにではなく、メモリに出力をおこないます。


引数 ms 出力先ストリームオブジェクト

戻り値 0 成功


説明 VrSetSpoolFi leName2 関数で出力先 PDF ファイル名を指定する代わり

にこの関数を使用すると、出力ファイルを物理ファイルとして生成するの

ではなく、メモリ上に Stream 出力することが可能になります。この機能を

利用することで、ASP.NET からクライアントに PDF ファイルを URL から戻

す際に、URL からの PDF ファイルの実参照を防ぐことができます。VrQuit

関数実行時に戻り値として Stream 出力をおこなった PDF のサイズが戻

り値として返されます。

C#における関数使用例

public void Button1_Click(object sender, System.EventArgs e)

{

Response.ContentType = "application/pdf";

MemoryStream ms = new MemoryStream();

Vrw32 svf = new Vrw32();

int ret;

svf.VrInit();


svf.VrSetSpoolFileStream(ms);



int instance.VrSetSpoolFileStream(MemoryStream ms);

Function instance.VrSetSpoolFileStream(ms As MemoryStream) As Integer

.NET、Java の Stream 機能を利用しているため、SVF Connect for ASP/COM API を

利用している場合には、本関数を利用することはできません。

ContentType および ContentLength は SVF for .NET Framework 製品群の関数で

はありません。しかし、この 2 つが.NET プログラム内で指定がされていない場合は、PDF

をブラウザに表示できないことがありますので、かならず使用してください（ Internet

Explorer を利用している場合）。

68

svf.VrEndRecord();

svf.VrPrint();

ret = svf.VrQuit();

Response.AppendHeader("Content-Length", ret.ToString());

Response.BinaryWrite(ms.ToArray());

Response.End();

}

3 API 関数

69

VrComout("/{SECU n}/")

機能 PDF のセキュリティ機能の有無を設定します。


引数 n モードを指定します。

0 セキュリティ機能を使用しません。

1 セキュリティ機能を使用します。

戻り値 0 成功


説明作成する PDF ファイルに対してセキュリティ機能を使用する場合に利用

します。

この関数が指定されていない場合は、環境設定の指定に従います。

使用例セキュリティ機能を使用します。

int instance.VrComout("/{SECU n}/");

Function instance.VrComout("/{SECU n}/") As Integer

Function instance.VrComout("/{SECU n}/") As Long

int VrComout(HSVFRCLIENT instance, "/{SECU n}/");

svf.VrComout("/{SECU 1}/");

svf.VrComout("/{SECU 1}/")

svf.VrComout("/{SECU 1}/")

VrComout(svf, "/{SECU 1}/");

70

VrComout("/{PSWD Password}/")

機能 PDF オープン時のパスワードを設定します。


引数 password

ユーザーパスワード

戻り値 0 成功


説明 PDF ファイルを開くときにパスワード入力を求める画面が表示されます。こ

の指定をおこなうことにより、PDF ファイルの閲覧を許可する、しないなど

の制限（セキュリティ）をかけることが可能になります。

指定できるパスワード文字列は、32 バイトまでとなります。

使用例 PDF オープン時のパスワードとして「userlock」と指定します。

int instance.VrComout("/{PSWD password}/");

Function instance.VrComout("/{PSWD password}/") As Integer

Function instance.VrComout("/{PSWD password}/") As Long

int VrComout(HSVFRCLIENT instance, "/{PSWD password}/");

svf.VrComout("/{PSWD userlock}/");

svf.VrComout("/{PSWD userlock}/")

svf.VrComout("/{PSWD userlock}/")

VrComout(svf, "/{PSWD userlock}/");

パスワードとして指定する文字はかならず半角英数文字としてください。2 バイト文字な

どは Acrobat の仕様上、利用することができません。

セキュリティパスワードの指定と併用する場合には、かならず異なるパスワード文字列を

指定してください。同じパスワード文字列が指定された場合、セキュリティパスワードは設

定されません。

パスワード文字列は 32 バイト以内で設定してください。

3 API 関数

71

VrComout("/{SECUPSWD Password}/")

機能 PDF のセキュリティパスワードを設定します。


引数 password セキュリティパスワード

戻り値 0 成功


説明 Acrobat 使用時に設定できる各種セキュリティ変更をおこなうためのパ

スワードを設定します。この指定をおこなうことにより、PDF のセキュリティ

変更保護が可能になります。

指定できるパスワード文字列は、32 バイトまでとなります。

使用例 PDF セキュリティ変更のためのパスワードとして「seculock」と指定します。

int instance.VrComout("/{SECUPSWD password}/");

Function instance.VrComout("/{SECUPSWD password}/") As Integer

Function instance.VrComout("/{SECUPSWD password}/") As Long

int VrComout(HSVFRCLIENT instance, "/{SECUPSWD password}/");

svf.VrComout("/{SECUPSWD seculock}/");

svf.VrComout("/{SECUPSWD seculock}/")

svf.VrComout("/{SECUPSWD seculock}/")

VrComout(svf, "/{SECUPSWD seculock}/");

パスワードとして指定する文字は、かならず半角英数字としてください。2 バイト文字は

Acrobat の仕様上、利用することができません。

PDF オープン時のパスワードの指定と併用する場合は、かならず異なるパスワードを指定

してください。同じパスワード文字列が指定された場合、セキュリティパスワードは設定され

ません。

パスワード文字列は 32 バイト以内で設定してください。

72

VrComout("/{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

戻り値 0 成功


int instance.VrComout("/{PERM n}/");

Function instance.VrComout("/{PERM n}/") As Integer

Function instance.VrComout("/{PERM n}/") As Long

int VrComout(HSVFRCLIENT instance, "/{PERM n}/");

3 API 関数

73

説明 PDF ファイル生成時にセキュリティの禁止項目の指定をおこないます。禁

止項目の設定は、項目の組み合わせにより該当するパラメータを指定す

ることで可能になります。

使用例作成する PDF に「印刷禁止」の設定をおこないます。

関数使用順

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();

svf.VrComout("/{PERM –8}/");

svf.VrComout("/{PERM –8}/")

svf.VrComout("/{PERM –8}/")

VrComout(svf, "/{PERM –8}/");

環境設定上でも禁止項目の設定が可能です。設定方法については、「SVF for .NET

Framework ユーザーズ・マニュアル」の「環境設定－機種別基本設定」で「PDF」の項


環境設定と VrComout の両方で禁止項目を設定した場合は、VrComout 関数による

設定が有効となります。

74

VrComout("/{FOUT n}/")

機能フィールドが存在しない帳票を出力するか、しないかを設定します。


引数 n モードを指定します。規定値は 0 となります。

0 フィールドが存在しない帳票を出力しません。

1 フィールドが存在しない帳票を出力します。

戻り値 0 正常


説明フィールドが存在しない帳票を出力させる場合に利用します。

この関数が指定されていない場合は、規定値(0：出力しない)となります。

使用例フィールドが存在しない帳票を出力します。

関数使用順

svf.VrInit();

svf.VrSetPrinter("", printer);


svf.VrComout("/{FOUT 1}/"); フィールドが存在しない帳票の出力を指定する

svf.VrEndPage();

svf.VrPrint();

svf.VrQuit();

int instance.VrComout("/{FOUT n}/");

Function instance.VrComout("/{FOUT n}/") As Integer

Function instance.VrComout("/{FOUT n}/") As Long

int VrComout(HSVFRCLIENT instance, "/{FOUT n}/");

svf.VrComout("/{FOUT 1}/");

svf.VrComout("/{FOUT 1}/")

svf.VrComout("/{FOUT 1}/")

VrComout(svf, "/{FOUT 1}/");

3 API 関数

75

印刷制御関数は、プリンタの機種により使用できる場合、使用できない場合がありますの

で、以下の表で、使用しているプリンタを確認してください。また使用できるとなっている場

合でも、使用できないこともありますので、事前にかならず動作検証をおこなってください。

≪対応機種一覧表≫

プリンタ固有の API関数プリンタ機種解像度

VrSetTray（トレイ番号） VrSetDuplex VrSetOutPutBin (排紙ビン番号)

PostScript 400dpi InputAtributes 辞書が有効な機種

のみ -１以外の負数指定なし -1 手差しトレイ０～ 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 に排紙

ESC/PAGE 300dpi ○ ○ ×

ESCP 180dpi ×

× ×

ESCPi 180dpi ×

× ×

VSP 240dpi or 400dpi

-1 指定なし 0 給紙口 1 1 給紙口 2 2 手差しまたは給紙トレイ 3 給紙口 3

× ×

ART4 400dpi or 600dpi

-1 自動選択 0 手差しトレイ 1～4

トレイ 1～4 21～23

マルチトレイ 2-1～2-3

○ MAINTRAY メイントレイ SIDETRAY サイドトレイ OUTBIN1～10

メールボックス 1 ビン～

10 ビン OUTBIN100

スタッカー OUTPUTBIN101～105

スタッカー1 ビン～5 ビン

共通関数-2（印刷制御関数）

76

プリンタ固有の API関数フォント画像ファイル

VrSetStaple（ステープル番号） VrSetSort（ソート番号） VrSetPunch（パンチ番号）クーリエ（内蔵） OCR-B 白黒 BMP カラーBMP PNG JPG

× × × ○ ○ ○ ○ ○ ○

× × × ○ × ○ × × ×

OFF 処理をおこないませ

ん。 TOPLEFT 左上一箇所 BOTLEFT 左下一箇所 MIDLEFT 左辺二箇所 TOPRIGHT 右上一箇所 BOTRIGHT 右下一箇所 MIDRIGHT 右辺二箇所 TOPCENTER 上辺二箇所

× × ○ ○ ○ ○ ○ ○

× × × ○ ○ ○ × × ×

× × × ○ ○ ○ × × ×

× × × × × ○ × × ×

× × × ○ × ○ × × ×

OFF ステープルなし TOPDUAL 上デュアル TOPLEFT 左上シングル TOPRIGHT 右上シングル BOTTOMDUAL 下デュアル BOTTOMLEFT 左下シングル BOTTOMRIGHT 右下シングル LEFTDUAL 左デュアル RIGHTDUAL 右デュアル

× × ○ × ○ × × ×

3 API 関数

77

プリンタ固有の API関数プリンタ機種解像度

VrSetTray（トレイ番号） VrSetDuplex VrSetOutPutBin（排紙ビン番号）

PCL5 300dpi ○ 0～6 から選択

○ ×

IBM5577 180dpi × × ×

IBM5577i 180dpi × × ×

PRESCRIBE2 300dpi 0 手差しトレイ 1 カセット 1 2 カセット 2 3 カセット 3 4 ハガキ／ユニバーサル・フィーダ

○ 0 プリンタの設定 1 フェースダウン 2 フェースアップ 3 ソータ

NPDL2 400dpi C0 指定なし C1 トレイ 1 C2 トレイ 2 C3 トレイ 3 C4 トレイ 4 C5 トレイ 5 M6 手差し

○ フェイスダウンフェイスアップフィニッシャスタッカ大容量スタッカ

PR201 160dpi 単票

前連帳

後連帳

× 無指定

前方排出

後方排出

PR201i 160dpi 単票

前連帳

後連帳

× 無指定

前方排出

後方排出

RPCS 600dpi 自動選択トレイ 1 トレイ 2 トレイ 3 トレイ 4 大容量給紙トレイ手差し

○ システム条件の設定横排紙トレイプルーフトレイプリントポスト 1 プリントポスト 2 プリントポスト 3 プリントポスト 4 プリントポスト 5 フィニッシャー・シフトトレイ標準トレイ

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 × × ×

SATO（MR410e）

305dpi × × ×

SATO（L'espritR8）

203dpi × × ×

TEC 300dpi × × ×

78

プリンタ固有の API関数フォント画像ファイル

VrSetStaple（ステープル番号） VrSetSort（ソート番号） VrSetPunch（パンチ番号）クーリエ（内蔵） OCR-B 白黒 BMP カラーBMP PNG JPG

× × × ○ × ○ × × ×

× × × ○ ○ ○ × × ×

× × × × × ○ × × ×

0 なし 1 手前 1 箇所 2 奥 1 箇所斜め、または、

奥 1 箇所平行 3 中央 2 箇所

× 0 なし 1 あり

○ ○ ○ × × ×

しない左上斜め右上斜め左 2 つ上 2 つ右 2 つ

しないする

× ○ ○ ○ × × ×

× × × ○ ○ ○ × × ×

× × × × × ○ × × ×

なし左上垂直右上垂直左上斜め右上斜め左 2 つ上 2 つ右 2 つ出力しない

× なし左上斜め上 2 つ右上斜め出力しない

○ × ○ ○ ○ ○

指定なしステープル処理なし

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 上

○ ○ ○ × × ×

× × × ○ ○ ○ × × ×

× × × × × ○ × × ×

× × × × × × × × ×

× × × ○ ○ ○ × × ×

OCR-B（内蔵）フォントはプリンタに搭載されていない場合は出力されません。

3 API 関数

79

VrSetTray

機能出力時の給紙トレイを指定します。


引数 Tray 給紙トレイ番号

0 トレイ指定なし

1 トレイ 1

2 トレイ 2

3 トレイ 3

4 トレイ 4

戻り値 0 成功


説明フォーム設計時に[ページの基本設定]ダイアログボックスで指定できる[ト

レイ選択]の設定を VrSetTray 関数で一時的に変更します。指定可能

な給紙トレイ番号は SVF 機種により異なります。［ SVF for .NET

Framework 環境設定］－［機種別基本設定］、または作成したプリンタ

の設定内にある［トレイ n］という設定内の「n」を指定してください。対応

機種については、p.75 の「対応機種一覧表」を参照してください。

使用例給紙トレイ 2 を指定します。

int instance.VrSetTray(int Tray);

Function instance.VrSetTray(Tray As Integer) As Integer

Function instance.VrSetTray(Tray As Long) As Long

int VrSetTray(HSVFRCLIENT instance, int Tray);

svf.VrSetTray( 2);

svf.VrSetTray( 2)

svf.VrSetTray( 2)

VrSetTray(svf, 2);

80

関数使用順

svf.VrInit();

svf.VrSetPrinter("",printer);

svf.VrSetForm("sample.frm",5);

svf.VrSetTray(2); ←VrSetForm 関数の後に発行します。

svf.VrsOut("Field", "Data");

svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

この関数を発行していない状態で、かつ様式ファイル内でもトレイ指定をおこなっていな

い場合は、用紙サイズを元にプリンタ実機側で出力をおこないます。同じ用紙サイズが

複数のトレイに入っている場合には、プリンタの設定により給紙トレイが異なります。

この部分は「基本的なプログ

ラムの流れ」を参照してくださ

い。

3 API 関数

81

VrSetDuplex

機能両面印刷の指定をおこないます。


引数 Mode 綴じ方向

0 解除

1 上綴じ

2 左綴じ

3 右綴じ

Margin 綴じ代（0～50mm ミリ単位）

戻り値 0 成功


説明両面印刷の指定をおこないます。対応機種については、p.75 の「対応機

種一覧表」を参照してください。この関数は VrSetForm 関数の後で指

定をおこないます。

使用例左綴じの両面印刷で綴じ代を 10mm と指定します。

int instance.VrSetDuplex(int Mode, int Margin);

Function instance.VrSetDuplex(Mode As Integer, Margin As Integer) As Integer

Function instance.VrSetDuplex(Mode As Long, Margin As Long) As Long

int VrSetDuplex(HSVFRCLIENT instance, int Mode, int Margin);

svf.VrSetDuplex( 2, 10);

svf.VrSetDuplex( 2, 10)

svf.VrSetDuplex( 2, 10)

VrSetDuplex(svf, 2, 10);

82

関数使用順

svf.VrInit();



svf.VrSetDuplex( 2, 10);


svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

複数の様式ファイルを使用して両面印刷をおこないたい場合

様式変更時の両面印刷の継続方法を３つのモードから選択することができます。下記

のモードの変更は、［SVF for .NET Framework 環境設定］－［機種別基本設定］また

は作成したプリンタの設定内にある［両面印刷制御］項目でおこないます。

・解除モード

様式ファイルが切り替わった場合、両面印刷を解除します。

・同一条件継続モード

新しい様式ファイル読み込み時に、前回利用した様式ファイルと比較して、以下

の条件に 1 つでもあてはまり、かつ印刷が片面で終わった場合は、両面印刷され

ずに片面印刷で排出されます。

・用紙サイズが異なる場合

・用紙方向が異なる場合

・給紙トレイが異なる場合

・縮小モードが異なる場合

・強制継続モード

強制的に両面印刷を継続します。

RPDL2 で出力する場合のみ、綴じ代は 5mm 単位となります。指定された端数は切り捨

てられます。

VSP で出力する場合には、プリンタの制御コマンドとして FNP シーケンスコマンドをプリン

タハード側で搭載している機種のみ両面印刷が可能になります。FNP コマンドでの出力

が必要となるので、 VSP で作成したプリンタの設定ファイル「 svf.cs. プリンタ

名 .VSP.properties」をテキストエディタで開き、「PDL=VSP」という部分を「PDL=FNP」と

変更してください。



3 API 関数

83

VrSetOutputBin

機能排紙先トレイを指定します。


引数 Bin 排紙先トレイ番号

戻り値 0 成功


説明出力時の排紙先トレイの指定をおこないます。この API 関数の指定がな

い場合にはプリンタ実機で設定されている排紙先に出力されます。指定

可能な排紙先トレイ番号は SVF 機種により異なります。[SVF for .NET

Framework 環境設定]－［機種別基本設定］または作成したプリンタの

設定内にある[排紙ビン n]という定義の「n」を指定してください。対応機

種については、p.75 の「対応機種一覧表」を参照してください。

使用例排紙先トレイ 1 を指定します。

int instance.VrSetOutputBin(int Bin);

Function instance.VrSetOutputBin(Bin As Integer) As Integer

Function instance.VrSetOutputBin(Bin As Long) As Long

int VrSetOutputBin(HSVFRCLIENT instance, int Bin);

svf.VrSetOutputBin( 1);

svf.VrSetOutputBin( 1)

svf.VrSetOutputBin( 1)

VrSetOutputBin(svf, 1);

84

関数使用順

svf.VrInit();


svf.VrSetForm( "C:¥¥svf¥¥sample.frm", 5);



svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

ステープル機能を併用する場合には、かならずフィニッシャー・シフトトレイを指定してく

ださい。

VSP で出力する場合には、プリンタの制御コマンドとして FNP シーケンスコマンドをプリン

タハード側で搭載している機種のみ両面印刷が可能になります。FNP コマンドでの出力

が必要となるので、 VSP で作成したプリンタの設定ファイル「 svf.cs. プリンタ

名 .VSP.properties」をテキストエディタで開き、「PDL=VSP」という部分を「PDL=FNP」と

変更してください。

3 API 関数

85

VrSetStaple

機能ステープル機能の指定をします。


引数 Location ステープル番号

戻り値 0 成功


説明ステープル機能の指定をおこないます。指定可能なステープル番号は

SVF 機種により異なります。

[SVF for .NET Framework 環境設定]－［機種別基本設定］または作

成したプリンタの設定内にある[ステープル n]という定義の「n」を指定して

ください。

対応機種については、p.75 の「対応機種一覧表」を参照してください。

使用例ステープル番号「2」を指定します。

int instance.VrSetStaple(int Location);

Function instance.VrSetStaple(Location As Integer) As Integer

Function instance.VrSetStaple(Location As Long) As Long

int VrSetStaple(HSVFRCLIENT instance, int Location);

svf.VrSetStaple( 2);

svf.VrSetStaple( 2)

svf.VrSetStaple( 2)

VrSetStaple(svf, 2);

排紙トレイには、かならずフィニッシャー･シフトトレイを指定します。

両面印刷機能やパンチ機能と併用する場合には、かならず綴じ方向を合わせます。

用紙方向により指定の位置で綴じることができない場合があります。用紙方向・指定

位置などの可否は、プリンタ付随のマニュアルで確認してください。

86

関数使用順

svf.VrInit();




svf.VrSetStaple( 1);


svf.VrEndPage();

svf.VrQuit();

3 API 関数

87

VrSetSort

機能出力紙のソートを指定します。


引数 Condition ソート番号

戻り値 0 成功


説明出力紙のソートをおこないます。指定可能なソート番号は SVF 機種により

異なります。［SVF for .NET Framework 環境設定］－［機種別基本設

定］、または作成したプリンタの設定内にある［ソート n］という定義の「n」

を指定してください。対応機種については、p.75 の「対応機種一覧表」を


使用例ソート番号「１」を指定します。

関数使用順

svf.VrInit();



svf.VrSetSort( 1);


svf.VrEndPage();

svf.VrQuit();

int instance.VrSetSort(int Condition);

Function instance.VrSetSort(Condition As Integer) As Integer

Function instance.VrSetSort(Condition As Long) As Long

int VrSetSort(HSVFRCLIENT instance, int Condition);

svf.VrSetSort( 1);

svf.VrSetSort( 1)

svf.VrSetSort( 1)

VrSetSort(svf, 1);

88

VrSetPunch

機能パンチ機能の指定をします。


引数 Location パンチ番号

戻り値 0 成功


説明パンチの指定をおこないます。指定可能なパンチ番号は SVF 機種により

異なります。[SVF for .NET Framework 環境設定]－［機種別基本設

定］または作成したプリンタの設定内にある[パンチ n]という定義の「n」を

指定してください。対応機種については、p.75 の「対応機種一覧表」を参


使用例パンチ番号「１」を指定します。

int instance.VrSetPunch(int Locatiion);

Function instance.VrSetPunch(Locatiion As Integer) As Integer

Function instance.VrSetPunch(Locatiion As Long) As Long

int VrSetPunch(HSVFRCLIENT instance, int Location);

svf.VrSetPunch( 1);

svf.VrSetPunch( 1)

svf.VrSetPunch( 1)

VrSetPunch(svf, 1);

排紙トレイには、かならずフィニッシャー･シフトトレイを指定します。

両面印刷やステープル機能と併用する場合には、綴じ方向を合わせます。

用紙方向によっては指定の位置にパンチができない場合があります。用紙方向・指定

位置などの可否は、プリンタ付随のマニュアルで確認してください。

3 API 関数

89

関数使用順

svf.VrInit();




svf.VrSetPunch( 1);


svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

90

この項の関数は、.NET アプリケーションから直接 SVF for .NET Framework を使用する場

合にのみ利用可能な関数です。SVF Connect ｆｏｒ .NET Framework API、SVF Connect

for ASP/COM API、および SVF Connect for Java API では使用できません。

VrComout("/{BIND p1 p2 p3}/") （Ver.2.01 から対応）

機能 SVF 機種の LIPS4 を使用した場合の、A3/A4 用紙混在時の印刷指定

をおこないます。


引数 p1 用紙の揃え方を指定します。

0 指定なし

1～4 用紙の揃え方のパターン

1～4 のパターンの詳細については、SVF for .NET

Framework ユーザーズ・マニュアルの「4 SVF for .NET

Framework 環境設定」－「機種別基本設定」の

「Canon LIPS4」の記述を参照してください。

p2 とじ代量を mm 単位で指定します。

p3 A3/A4 用紙混在時のメディアタイプを指定します。

0 次のカラー機種から出力する場合

LBP-2710

LBP-2810

LBP.5900

LBP-5800

1 次のモノクロ機種から出力する場合

LBP-1420

LBP-1620

LBP-1820

LBP-1910

LBP-3700

LBP-3800

使用例揃え方パターン 1、とじ代 10mm で、LBP-1820 に出力します。

.NET アプリケーションから直接呼出時のみ使用できる関数

int instance.VrComout("/{BIND p1 p2 p3}/");

Function instance. VrComout("/{BIND p1 p2 p3}/") As Integer

svf.VrComout("/{BIND 1 10 1}/");

svf.VrComout("/{BIND 1 10 1}/")

3 API 関数

91

VrEnablePreview

機能印刷イメージを画面に表示します。

プレビューするタイミングで、内部でプレビュー用ファイル（EMF 形式）を作

成し、プレビュー画面に表示します。


引数 mode 0 プレビューしない

1 プレビューする

x SVF for .NET Framework ではプレビュー画面での入力はおこ

なえませんが、この引数には任意の数値を指定する必要があり

ます。

説明 VrEnablePreview 関数は VrInit 関数と VrSetForm 関数の間で実行し

ます。ただし VrSetPrinter 関数が定義されている場合は、VrSetPrinter

関数の後で指定します。

関数使用順

svf.VrInit(); svf.VrSetPrinter( "", printer); svf.VrEnablePreview(1,1); svf.VrSetForm( "sample.frm", 5); svf.VrPrint();

svf.VrQuit();

A3/A4 用紙混在出力の指定は、SVF 機種の LIPS4 を使用して印刷する場合にのみ

有効です。

SVF for .NET Framework 環境設定上のプリンタ、または機種別基本設定の［Canon

LIPS4］の設定で、「周辺機器の制御方法」に「CPCA-LBP」を予め指定しておく必要が

あります。

int instance.VrEnablePreview(int mode, int x);

Function instance.VrEnablePreview(mode As Integer, x As Integer) As Integer

プレビュー画面は VrQuit()が発行されたタイミングで表示されます。

SVF for .NET Framework ではプレビュー用ファイルを生成する関係で、すべてのペー

ジがプレビューされます。

ASP.NET（Web アプリケーション）での実行時には、プレビュー機能を利用することはでき

ません。

VrStack、VrStackOut と VrEnablePreview は併用できません。スタック印刷する場合

にはプレビューせずに印刷してください。

92

VrComout(“/{PPSM mode}/")（Ver.2.1 から対応）

機能プレビュー画面で、出力先のプリンタの変更をできるようにするか、しない

かを指定します。この機能を利用できるのは、SVF 機種「ImagePrinter」

を使用した印刷の場合のみです。


引数 mode true プリンタの変更を有効にする

false プリンタの変更を無効にする

説明 SVF 機種「ImagePrinter」を使用して印刷する場合に限り、プレビュー画

面の表示後に出力先のプリンタの変更できるようにすることが可能です。

出力先プリンタの変更をできるようにするか、しないかを指定します。

下記に具体的な出力先指定方法の例を示します（印刷先指定および

SVF 機種決定の詳細については「SVF for .NET Framework ユーザー

ズ･マニュアル」、「SVF for .NET Framework/MetaFrame Edition のユー

ザーズ･マニュアル」、本マニュアル「VrSetPrinter()」の項を参照してくだ

さい。

① SVF 機種「ImagePrinter」を使用して環境設定上に作成したプリン

タを指定する場合

例 VrSetPrinter("", “PRINTER_A")

※PRINTER_A は、環境設定上のプリンタ名です。

② 出力先指定時に、Windows 上のプリンタ名を指定し、かつ SVF 機

種「ImagePrinter」を明示的に指定した場合

例 VrSetPrinter(" ImagePrinter", "RICOH IPSiO NX920")

※"RICOH IPSiO NX920"は、Windows 上のプリンタ名です。

③ 出力先指定時に、Windows 上のプリンタ名のみを指定し、変換

テーブルによって SVF 機種「ImagePrinter」が使用される場合

例 VrSetPrinter("", "RICOH IPSiO NX920")

※ "RICOH IPSiO NX920"は、Windows 上のプリンタ名、変換

テーブルにより SVF 機種「ImagePrinter」が使用される

関数使用順 svf.VrInit(); svf.VrSetPrinter( "", printer); svf.VrEnablePreview(1,1); svf.VrComout("/{PPSM true}/") svf.VrSetForm( "sample.frm", 5); svf.VrPrint();

svf.VrQuit();

int instance.VrComout(“/{PPSM mode}/");

Function instance.VrComout(“/{PPSM mode}/") As Integer

3 API 関数

93

VrEnablePrintBTN（Ver.2.2 から対応）

機能印刷プレビュー画面上の［印刷実行］ボタンの活性化/非活性化を制御

します。


引数 mode 0 [印刷実行]ボタンを活性化しません。

1 プレビューに 1 ページ目が表示されたタイミングで[印刷実

行]ボタンを活性化します。

2 プレビューに最終ページまで表示されたタイミングで[印刷

実行]ボタンを活性化します。

戻り値 0

使用例全ページのプレビュー表示がされたタイミングで[印刷実行]ボタンを活性

化します。

SVF 機種「ImagePrinter」以外が使用された印刷時は、この機能は使用できません。

SVF for .NET Framework 環境設定での指定と API での指定が異なる場合、API で

の指定が優先されます。

環境設定に登録されたプリンタから出力先のプリンタが変更された場合は、環境設定

上のプリンタの設定に関わらず、変更後のプリンタに対して機種別基本設定の

「ImagePrinter」の設定が適用され、その内容で印刷されます。

int instance.VrEnablePrintBtn(int mode);

Function instance.VrEnablePrintBTN(mode As Integer) As Integer

ｓvf.VrEnablePrintBTN(2);

Svf.VrEnablePrintBTN(2)

94

VrGetAttribute(“$PREVIEWUSERSETTINGS$”, Param, Value)（Ver.2.2 から対応）

機能プレビュー画面の［ページ設定］で指定した［印字位置調整］の値を取得

します。


引数 Param

設定情報の中から取得したい一つのキーワードを指定します。

指定しない場合、設定情報のすべてを取得します。

""（空文字）

設定情報のすべてを取得

"ADJUSTMX"

［調整値］の［X］で指定された値（ミリ単位）を取得

"ADJUSTMY"

［調整値］の［Y］で指定された値（ミリ単位）を取得

"ADJUSTDX"

［調整値］の［X］で指定された値（ドット単位）を取得

"ADJUSTDY"

［調整値］の［Y］で指定された値（ドット単位）を取得

Value

取得したプレビュー画面での設定値

プレビュー画面で変更がなかった値、またはプレビュー画面の表

示が OFF の場合は、この値は空文字となります。

戻り値 0

設定したキーワードと取得した値の例を記載します。

Param Value 備考

""（空文字） "ADJUSTMX=100,

ADJUSTMY=200"

ミリ単位で X=100、Y=200 の

調整をおこなった場合

"ADJUSTMX" "100" 同上

"ADJUSTMY" "200" 同上

"ADJUSTDX" "150" ドット単位で X=150、Y=150 の

調整をおこなった場合

"ADJUSTDY" "150" 同上

int instance.VrGetAttribute(“$PREVIEWUSERSETTINGS$”, string Param, StringBuilder Value);

Function instance.VrGetAttribute(“$PREVIEWUSERSETTINGS$”, Param As String, Value As StringBuilder) As Integer.

3 API 関数

95

使用例［印字位置調整］の［X］（mm）の値を取得します。

svf.VrGetAttribute(“$PREVIEWUSERSETTINGS$”, “ADUJUSTMX”, Value);

svf.VrGetAttribute(“$PREVIEWUSERSETTINGS$”, “ADUJUSTMX”, Value)

VrGetAttribute(“$PREVIEWUSERSETTING$” , Param, Value)は、VrQuit()発行の直

前に記述する必要があります。

96

VrComout("/{REDU mode type}/")（Ver.2.2 から対応）

機能［環境設定］の各プリンタ機種設定の設定項目のうち、［拡大縮小モー

ド］、［拡大縮小用紙サイズ］を API で指定することができます。

発行タイミングは、VrSetPrinter()の直後、または VrsOut()系メソッドより

前となります。


引数 mode 拡大縮小モード（0～2）

0 様式に従う(プリンタ機能を使う)

1 指定サイズ

2 様式に従う(プリンタ機能を使わない)

type 拡大縮小用紙サイズ（0～6）

0 はがき

1 A5

2 A4

3 A3

4 B5

5 B4

6 レター

戻り値 0

使用例指定サイズ A4 で印刷します。

int instance.VrComout(“/{REDU mode type}/”);

Function instance.VrComout(“/{REDU mode type}/”) As Integer

svf.VrComout(“/{REDU 1 2}/”);

svf.VrComout(“/{REDU 1 2}/”)

3 API 関数

97

VrEnumPrinters

機能 Windows に登録されているプリンタのプリンタ名一覧を取得します。

サーバ上で実行した場合

サーバマシンに登録されているプリンタの一覧を取得します。

ClickOnce およびノータッチデプロイメントで実行した場合

クライアントコンピュータ上の Windows に登録されているプリンタ

の一覧を取得します。

SVF for .NET Framework/MetaFrame Edition を使用している場合

MetaFrame サーバの Windows 上に登録されているプリンタおよ

びリモート接続されている場合には、リモートクライアント側の

Windows に登録されているプリンタ（スリムプリントのプリンタ）も

一覧で取得します。


引数 str 取得したプリンタ名が配列に返されます。配列の先頭には、

Windows 上（SVF for .NET Framework/MetaFrame Edition

使用時には、ICA クライアント上）で「通常使うプリンタ」に設定さ

れているプリンタの名前が返されます。

bytecount

SVF for .NET Framework では使用されませんが、指定が必要

です。

初期値として、int(Integer)型が扱える範囲の数値を与えておく

必要があります。

count 取得したプリンタの数が返されます。

使用例 Windows に登録されているプリンタの一覧を取得します。

int instance.VrEnumPrinters(out string[] str, int bytecount, out int count);

Function instance.VrEnumPrinters(ByRef str() As String, bytecount As Integer, ByRef count As Integer) As Integer

string[] str; int bytecount = 0; int count; svf.VrInit(); svf.VrEnumPrinters(out str, int bytecount, out count); svf.VrQuit();

98

ノータッチデプロイメントでの関数使用順

svf.VrSmartClient("http://computer/svf");

svf.VrInit();

svf.VrEnumPrinters (out str, bytecount, out count);

svf.VrQuit();

:

取得したプリンタをユーザ画面に表示させる

:

（MetaFrame）サーバ上での関数使用順

svf.VrInit();

svf.VrEnumPrinters (out str, bytecount, out count); svf.VrQuit(); : 取得したプリンタをユーザ画面に表示させる

:

Dim str() As String Dim bytecount As Integer = 0 Dim count As Integer svf.VrInit() svf.VrEnumPrinters(str.bytecount.count) svf.VrQuit()

3 API 関数

99

VrGetFieldCount

機能様式ファイル内に設計されているフィールドの総数を取得します。


引数なし

戻り値整数フィールド数


説明 VrSetForm()関数で指定された、様式ファイル内に設計されているフィー

ルドの数を戻り値として返します。


int instance.VrGetFieldCount();

Function instance.VrGetFieldCount() As Integer

int count = svf.VrGetFieldCount();

Dm count As Integer = svf.VrGetFieldCount()

100

VrGetFieldName

機能フィールド名を取得します。


引数 index フィールドインデックス

（0 以上 VrGetFieldCount で取得した数未満）

buf フィールド名格納先

戻り値 0 正常


説明 VrGetFieldCount()関数で取得したフィールド数未満の値をインデックス

として指定することで、そのインデックスのフィールド名を取得することが

できます。


VrGetFieldType

機能フィールドのデータ型を取得します。




戻り値 0 文字型

1 数値型

int instance.VrGetFieldName(int index, System.Text.StringBuilder sb);

Function instance.VrGetFieldName(index As Integer, sb As System.Text. StringBuilder) As Integer

svf.VrGetFieldName(count, sb);

svf.VrGetFieldName(count, sb)

int instance.VrGetFieldType(int index);

Function instance.VrGetFieldType(index As Integer) As Integer

3 API 関数

101

2 バーコードフィールド

3 ビットマップフィールド



として指定することで、そのインデックスのフィールドのタイプを取得するこ

とができます。


VrGetFieldLength

機能フィールドの桁数を取得します。


引数 index フィールドインデックス（0 以上 VrGetFieldCount で取得した数

未満）

戻り値整数フィールド桁数



として指定することで、そのインデックスのフィールドの桁数を取得するこ

とができます。

フィールドがリンクフィールドだった場合には、以下のような値を返します。

・リンク元フィールドの場合

リンク先フィールドの桁数も合わせたフィールド桁数を戻り値とし

て返します。

・リンク先フィールドの場合

フィールド桁数は 0 が返されます。


int type = svf.VrGetFieldType(count);

Dim type As Integer = svf.VrGetFieldType(count)

int instance.VrGetFieldLength(int index);

Function instance.VrGetFieldLength(index As Integer) As Integer

int len = svf.VrGetFieldLength(count);

102

VrGetFieldRepeatCount

機能フィールドの繰り返し数を取得します。




戻り値整数繰り返し数



として指定することで、そのインデックスのフィールドの繰り返し数を取得

します。

繰り返しフィールドでない場合は、戻り値として 0 を返します。1 以上が

返ってきた場合は、データを出力する際に Vr?Outn 関数を利用し、繰り

返し行数を指定してデータを出力してください。


Dim len As Integer = svf.VrGetFieldLength(count)

リンク先フィールドに出力されるデータは、もとがリンク元フィールドにのみ出力されている

データであり、リンク先フィールドに直接データが出力されているわけではありません。その

ため、戻り値として「0」が返されます。

int instance.VrGetFieldRepeatCount(int index);

Function instance.VrGetFieldRepeatCount (index As Integer) As Integer

int repeat = svf.VrGetFieldRepeatCount(index);

Dim repeat As Integer = svf.VrGetFieldRepeatCount(index)

繰り返しフィールドに対して Vr?Outn()関数を利用して出力する場合は、VrSetForm()

関数のモードが 1 である必要があります。

3 API 関数

103

VrGetFieldRecordType

機能フィールドが入っているレコードの属性を取得します。




戻り値 0 レコードには属さないフィールド

1 明細レコードに属するフィールド

2 合計レコードに属するフィールド

3 ヘッダーレコードに属するフィールド

4 総計レコードに属するフィールド


として指定することで、そのインデックスのフィールドがどのタイプのレコード

に属しているかを取得します。


VrGetPageRecordCount

機能行数を取得します。


引数なし

int instance.VrGetFieldRecordType(int index);

Function instance.VrGetFieldRecordType(index As Integer) As Integer

int record = svf.VrGetFieldRecordType(count);

Dim record As Integer = svf.VrGetFieldRecordType(count)

int instance.VrGetPageRecordCount();

Function instance.VrGetPageRecordCount() As Integer

104

戻り値整数データ行数


説明繰り返しフィールドが作成されている様式ファイルに対して VrSetForm()

関数のモード 4、またはモード 5 で出力しようとした場合の、様式ファイル

内に出力可能なデータ行数を取得します。


関数使用例

svf.VrInit();



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();

int record_cnt = svf.VrGetPageRecordCount();

Dim record As Integer = svf.VrGetPageRecordCount()

繰り返しフィールドを使用している様式ファイルを利用して VrSetForm()関数のモード

4、またはモード 5 で出力する場合は、Vr?Out()関数を利用して 1 行分の繰り返し行に

対してデータを出力した後に、VrEndRecord()関数を発行してください。

3 API 関数

105

SVF for .NET Framework ノータッチデプロイメント機能で使用する場合 API 関数は、以

下のとおりです。

VrSmartClient

機能指定された Web サーバからの SVF for .NET Framework 関連ファイル

のダウンロードをおこないます。

ダウンロードされたファイルは、ダウンロードキャッシュに格納されます。


引数 URL SVF for .NET Framework の実行ファイルが存在する URL を指

定します。

戻り値 0 成功


使用例実行ファイルが存在する URL に「http://computer/svf」を指定します。

関数使用順


svf.VrInit

VrSetPrinter(" ","PDF")

VrSetForm("c:¥¥test¥¥sample.frm","1")

VrsOut("会社名","ウイングアークテクノロジーズ株式会社")

:

VrEndPage()

VrQuit()

ノータッチデプロイメント機能使用時の関数

int instance.VrSmartClient(string URL);

Function instance.VrSmartClient(URL As String) As Integer


svf.VrSmartClient("http://computer/svf")

106

SVF for .NET Framework/CSV Option のみで使用できる API 関数は、CSV ファイル生成

時のファイル作成方法を指定する関数となります。

VrSetCSVFileName

機能様式ファイルの設計に従って、出力結果を CSV 形式のファイルに出力し

ます。


引数 Fi leName 出力する CSV ファイル名（パスを含む）

Level 変換レベル（0～2）

0 単純変換（縦罫線での区切りなし）

1 単純変換（縦罫線での区切りあり）

2 複雑変換（縦罫線での区切りあり、同列のデータ数を

考慮）

Mode 変換モード（0 or 1）

0 フィールド文字列のみ出力

1 フィールド文字列と固定文字出力

戻り値 0 成功


説明作成する CSV ファイル名と作成場所を指定します。この関数を発行しな

い場合は、SVF for .NET Framework 環境設定画面上で作成された

CSV プリンタの詳細定義での指定内容に従います。環境設定の詳細に

ついては、「SVF for .NET Framework Options ユーザーズ・マニュアル」

の「第 2 章 SVF for .NET Framework/CSV Option」－「環境設定－機

種別基本設定」の項を参照してください。

SVF for .NET Framework/CSV Option 使用時の関数

int instance.VrSetCSVFileName(string FileName, int Level, int Mode);

Function instance.VrSetCSVFileName(FileName As String, Level As Integer, Mode As Integer) As Integer

Function instance.VrSetCSVFileName(FileName As String, Level As Long, Mode As Long) As Long

int VrSetCSVFileName (HSVFRCLIENT instance, Char *FileName, int Level, int Mode);

3 API 関数

107

使用例「sample.csv」を複雑変換でフィールドと固定文字を出力して作成します。

関数使用順

svf.VrInit();

svf.VrSetPrinter("", "CSV");

svf.VrSetCSVFileName("sample.csv", 2, 1);



svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

svf.VrSetCSVFileName("C:¥¥svf¥¥sample.csv", 2, 1);

svf.VrSetCSVFileName("C:¥¥svf¥¥sample.csv", 2, 1)

svf.VrSetCSVFileName("C:¥¥svf¥¥sample.csv", 2, 1)

VrSetCSVFileName(svf, "C:¥¥svf¥¥sample.csv", 2, 1);

108

この関数は、SVF Connect for .NET Framework API、SVF Connect for ASP/COM API、

および SVF Connect for Java API からの利用可能な関数です。

VrComout("/{CSMD n}/") （Ver.2.1 から対応）

機能 PDF ファイル、および CSV ファイルの出力時、ファイルの保存先を次の 2

つのいずれかに切り替えます。

・サーバ（SVF for .NET Framework がセットアップされたコンピュータ）

・クライアント（アプリケーションが動作しているコンピュータ）


引数 n 保存先の指定（0 or 1）

0 クライアント

1 サーバ

戻り値 0 固定

説明 PDF ファイル、CSV ファイルの保存先コンピュータを指定します。

この関数を発行しない場合は、デフォルトでクライアントコンピュータに保

存されます。各コンピュータ上でファイルが保存されるパスは、PDF ファイ

ルの場合は「 VrSetSpoolFi leName2 」、 CSV ファイルの場合は

「VrSetCSVFileName」を使用して指定します。

使用例サーバにファイルを保存します。

コネクト製品からの呼び出し時のみ使用できる関数

int instance.VrComout("/{CSMD n}/");

Function instance.VrComout("/{CSMD n}/") As Integer

Function instance.VrComout("/{CSMD n}/") As Long

Int VrComout (HSVFRCLIENT instance, "/{CSMD n}/");

svf.VrComout("/{CSMD 1}/");

svf.VrComout("/{CSMD 1}/")

svf.VrComout("/{CSMD 1}/")

3 API 関数

109

関数使用順

svf.VrInit();

svf.VrComout("/{CSMD 1}/"); ← VrInit()の直後に呼び出す


svf.VrSetSpoolFileName2("sample.pdf");



svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

VrComout(svf, "/{CSMD 1}/");



110

SVF for Web/Client で使用する場合 API 関数は、以下のとおりです。SVF for Web/Client

を使用する場合、出力データを圧縮する必要があります。

VrComout("/SPLM n}/")

機能出力データファイルの圧縮を指定します。


引数 n モードの指定

１プリンタに出力

２ファイル出力（圧縮しない）

３ファイル出力（圧縮する）

戻り値 0 成功


説明 SVF for Web/Client を利用している際には、ネットワーク上のデータ転送

の付加を軽減するために、印刷データを圧縮して作成し、クライアント側

で解凍し印刷を実行します。このため、かならずファイル出力時に圧縮す

る指定をおこないます。

製品の詳細については「SVF for Web/Client ユーザーズ・マニュアル」を


使用例印刷データを圧縮します。

SVF for Web/Client 使用時の関数

int instance.VrComout("/{SPLM n}/")

Function instance.VrComout("/{SPLM n}/")As Integer

Function instance.VrComout("/{SPLM n}/") As Long

int VrComout (HSVFRCLIENT instance, "/{SPLM n}/");

svf.VrComout("/{SPLM 3}/")



3 API 関数

111

関数使用順

svf.VrInit();

svf.VrSetPrinter("","EMF");

svf.VrSetSpoolFileName2(C:¥¥svf¥¥emf¥¥sample.wdd");

svf.VrComout("/{SPLM 3}/");


svf.VrsOut("F1","data");

svf.VrEndRecord();

svf.VrPrint();

svf.VrQuit();

VrComout(svf, "/{SPLM 3}/");

索引-1

索引 ··································································································································································································

数字

32 ビット型整数 ...............................................14

64 ビット型整数 ...............................................16

Ａ

API 関数 .............................................................6

Ｃ

CSV 形式 ..................................................63, 106

Ｊ

jp.co.fit.Vfreport.SvfrClient.dll .........................2

Ｎ

Null チェック機能 ..............................................1

Ｐ

PAGE() .............................................................31

Ｓ

SVF for .NET Framework/CSV Option ........106

SVF for Web/Client........................................110

SVFCS.dll ......................................................1, 3

svfrclient.dll.......................................................3

svfrclient.jar ......................................................4

Ｖ

VrAbortDoc ......................................................60

VrAdjustd.........................................................37

VrAdjustd2.......................................................39

VrAdjustm........................................................37

VrAdjustm2......................................................39

VrAttribute ......................................................41

VrAttributen.................................................... 41

VrComout("/{PERM n}/")................................. 72

VrComout("/{PSWD Password}/") ................... 70

VrComout("/{SECU n}/") ................................. 69

VrComout("/{SECUPSWD Password}/")......... 71

VrComout("/SPLM n}/") ................................ 110

VrComout("/{BIND p1 p2 p3}/") ...................... 90

VrComout("/{CSMD n}/")............................... 108

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

VrComout("/{REDU mode type}/") .................. 96

VrComout(“/{PPSM mode}/".......................... 92

VrCondition..................................................... 29

VrCopy............................................................. 33

VrDataOut....................................................... 65

VrEnablePreview ............................................ 91

VrEnablePrintBTN......................................... 93

VrEndPage ...................................................... 20

VrEndRecord................................................... 24

VrEnumPrinters ............................................. 97

VrGetAttribute................................................ 49

VrGetAttribute("$PREVIEWUSERSETTINGS$",

Param, Value).................................................... 94

VrGetFieldCount............................................. 99

VrGetFieldLength......................................... 101

VrGetFieldName........................................... 100

VrGetFieldRecordType ................................. 103

VrGetFieldRepeatCount ............................... 102

VrGetFieldType............................................. 100

VrGetPageRecordCount................................ 103

VrGetStatus .................................................... 63

VrInit ................................................................. 6

VriOut.............................................................. 14

VriOutn ........................................................... 14

VrlOut.............................................................. 16

VrlOutn ........................................................... 16

索引-2

VrOutputQuery................................................63

VrPage..............................................................56

VrPaperEject....................................................54

VrPrint .............................................................25

VrQuit ................................................................8

VrReport...........................................................23

VrrOut..............................................................18

VrrOutn............................................................18

VrSeqOut .........................................................55

VrSetCalcMode ................................................61

VrSetCSVFileName.......................................106

VrSetDocName2 ..............................................36

VrSetDuplex ....................................................81

VrSetForm .........................................................9

VrSetOutputBin ..............................................83

VrSetPageCount ..............................................31

VrSetPrinter ....................................................26

VrSetPunch......................................................88

VrSetQuery ......................................................21

VrSetSort .........................................................87

VrSetSpoolFileName2 .....................................34

VrSetSpoolFileStream.....................................67

VrSetStaple......................................................85

VrSetTray.........................................................79

VrSmartClient ...............................................105

VrsOut..............................................................12

VrsOutn............................................................12

VrStack ............................................................58

VrStackOut ......................................................58

VrTest...............................................................52

あ

アセンブリ名 ..............................................1, 2, 3

アプリケーション ...................................1, 2, 3, 4

い

イメージファイル名出力.................................. 12

印刷イメージ.................................................... 91

印刷開始........................................................... 20

［印刷実行］ボタンの活性化/非活性化 ........... 93

印刷制御関数.................................................... 75

印刷の中止 ....................................................... 60

印刷部数指定.................................................... 33

印字位置一時調整 ............................................ 39

印字位置調整.............................................. 37, 94

印字対象ページ ................................................ 56

か

解放 .................................................................... 8

拡大縮小モード ................................................ 96

拡大縮小用紙サイズ ......................................... 96

加算値 .............................................................. 31

き

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

給紙トレイ ....................................................... 79

行数取得......................................................... 103

禁止項目........................................................... 72

く

クエリー........................................................... 29

クエリーの実行 ................................................ 23

クエリーファイル指定 ..................................... 21

こ

コネクト製品.................................................. 108

し

シーケンシャルモード ..................................... 55

索引-3

十進演算ライブラリ .........................................61

実数 ..................................................................18

出力先プリンタの変更 ......................................92

出力終了 .............................................................8

出力データファイルの圧縮.............................110

出力プリンタ指定 .............................................26

出力のモードを指定 ...........................................9

初期化 .................................................................6

す

スタック印刷 ....................................................58

ステータス........................................................63

ステープル機能.................................................85

スプーラ ...........................................................36

せ

セキュリティ機能 .............................................69

セキュリティパスワード設定 ...........................71

設計関数 ...........................................................31

そ

ソート ...............................................................87

た

対応機種一覧表.................................................75

ち

抽出条件指定 ....................................................29

つ

綴り ..................................................................56

て

データ型の取得...............................................100

テーブルデータの一括出力...............................65

テスト印刷 ....................................................... 52

と

動作環境................................................. 1, 2, 3, 4

の

ノータッチデプロイメント ............................ 105

は

排紙先 .............................................................. 83

排出 .................................................................. 54

パスワード設定 ................................................ 70

パンチ機能 ....................................................... 88

ふ

ファイル出力.................................................... 34

ファイルの保存先 .......................................... 108

ファイル名 ....................................................... 34

フィールドが存在しない帳票........................... 74

フィールド繰り返し数取得 ............................ 102

フィールド桁数取得 ....................................... 101

フィールドの総数 ............................................ 99

フィールドの属性 ...................................... 41, 49

フィールド名取得 .......................................... 100

複数ページ ....................................................... 56

部数 .................................................................. 33

プリンタ........................................................... 26

プリンタ一覧の取得 ......................................... 97

プレビュー画面 .......................................... 93, 94

文書名 .............................................................. 36

め

明細レコード.................................................... 24

メモリ出力 ....................................................... 67

索引-4

も

文字型データ出力 .............................................12

よ

様式ファイル ......................................................9

ら

ライブラリ名 ..................................................3, 4

り

両面印刷........................................................... 81

れ

レコード属性取得 .......................................... 103

レポートライターモード.................................. 25

SVF for .NET Framework API 関数リファレンス・マニュアル Ver.2.2

2008年 5月第1版販売元：ウイングアークテクノロジーズ株式会社［本社］〒108-0075 東京都港区港南 1-8-15 W ビル 14F

TEL：03-6710-1700（代表） FAX：03-6710-1701

ホームページ：http://www.wingarc.co.jp

開発元：株式会社エフ・アイ・ティ

〒102-0071 東京都千代田区富士見 2-14-37 FUJIMI EAST 2F

※本マニュアルに記載されている社名および商品名は、一般に各社の商標および登録商標です。 ※本マニュアルは予告なく変更することがあります。

svf for .net framework api関数リファレンス・マ …...1 api関数の呼び出し方法 1 1...

Documents