jvSetString（文字型情報設定）

各種のプロパティを設定します。

[構文]
 
Function jvSetString(ByVal jid As Long, ByVal mode As Long, ByVal sval As String) As Long
 
C言語
int jvSetString(int jid, int mode, char *sval);
 
JAVA
int jvSetString(int jid, int mode, String sval);
 
Delphi
Function jvSetString(jid, mode: Longint; sval: PAnsiChar): Longint;
 

設定項目

内容

jid

jvCreateで取得したジョブID

mode

プロパティの種類（設定値参照）

sval

プロパティの設定値（設定値参照）

 
リターンコード
 

定数

値

内容

 

0

正常終了

JV_ERR_JOBID

-3

ジョブ識別番号エラー

JV_ERR_PARAMETER

-2

パラメータエラー

JV_ERR_FONTEMBED_FILE

-124

 フォントが埋め込めない

 
[設定値]
 
mode には次の値を設定します。
 

定数

値

内容

JV_FORM_PATH_NAME

1

フォームファイル検索パス(256バイト以下)

JV_IMAGE_PATH_NAME

2

イメージファイル検索パス(256バイト以下)

JV_REPLACE_CHAR

3

数値フィールドオーバーフロー時の代替文字

JV_GRID_SEPARATOR

4

グリッドフィールドデータの区切り記号

JV_RDF_KEY1 〜　JV_RDF_KEY5

11〜15

RDFドキュメントのキー(32バイト以下)

JV_PDF_BOOKMARK

19

Adobe PDFドキュメントのブックマーク

JV_PDF_OWNER_PASSWORD

20

AdobePDFドキュメントのオーナーパスワード(20バイト以下)

JV_PDF_USER_PASSWORD

21

AdobePDFドキュメントのユーザーパスワード(20バイト以下)

JV_PDF_AUTHOR

22

AdobePDFドキュメントの作成者(256バイト以下)

JV_PDF_CREATOR

23

AdobePDFドキュメントのアプリケーション(256バイト以下)

JV_PDF_TITLE

24

AdobePDFドキュメントのタイトル(256バイト以下)

JV_PDF_SUBJECT

25

AdobePDFドキュメントのサブタイトル(256バイト以下)

JV_PDF_KEYWORD

26

AdobePDFドキュメントのキーワード(256バイト以下)

JV_PDF_FONTEMBED

29

AdobePDFドキュメントに埋め込むフォント名

JV_GAIJI_FILE

31

ジャイブレポート外字ファイル名

JV_DOCUMENT_DATATYPE

34

プリントデータ型

 
[解説]
 
jvSetStringは文字列を設定するファンクションです。数値を設定する場合はjvSetLongを使います。
 
フォームファイル検索パス（JV_FORM_PATH_NAME）
フォームファイルの検索パスを指定します。ここで指定されたパスは優先順位が最も高く、最初に検索されます。
 
イメージファイル検索パス（JV_IMAGE_PATH_NAME）
イメージファイルの検索パスを指定します。ここで指定されたパスは優先順位が最も高く、最初に検索されます。フォームに貼り付いている固定イメージ、jvDrawImage、jvSetFieldImage のイメージファイルに対して有効です。
 
数値フィールドオーバーフロー制御（JV_REPLACE_CHAR）
jvSetFieldText や jvSetFieldGrid でオーバーフローが発生した時の代替文字を指定します。
ここでは、数値型編集子を持つフィールドの代替文字を設定します。文字型編集子のオーバーフローは、jvSetLong で設定します。オーバーフローが発生した時に代替文字が設定されていないと、フィールドには何も表示されません。代替文字の設定を行っても、オーバーフローが発生した時は、ユーザーにオーバーフローを知らせるためオーバーフローエラーが返ります。
 
グリッドフィールドデータの区切り記号（JV_GRID_SEPARATOR）
グリッドフィールドの列データを区切る区切り記号を指定します。指定できる記号は、タブコード（chr(9))、スペース、カンマ、コロン、セミコロンの５種類です。デフォルトはカンマです。
 
RDFドキュメントのキー（JV_RDF_KEY1 〜　JV_RDF_KEY5）
RDFドキュメントにキーをつけます。キーは、説明やタイトルなどに利用できます。ここでつけたキーは、プレビューコントロールの Key プロパティを使って参照することができます。キーは、１から５までつけることができます。キーはjvCreatの出力先デバイスが「JV_RDF」の場合のみ使用できます。
 
Adobe PDFドキュメントのブックマーク（JV_PDF_BOOKMARK）
Adobe PDFドキュメントにブックマーク（しおり）をつけます。ブックマークは、設定したページのみにつきます。 全ページにつける場合は、各ページ毎にブックマークをつけます。ブックマークをUNICODEでつける場合は、jvSetStringW を使います。ブックマークはjvCreatの出力先デバイスが「JV_PDF」の場合のみ使用できます。
 
Adobe PDFドキュメント設定（20〜26）
Adobe PDFドキュメントの各種の情報を設定します。情報は、jvStartDoc の前で取得します。
ユーザーパスワードを設定すると、利用時にユーザーパスワードが必要となります。
作成者、アプリケーション名、タイトル、サブタイトル、キーワードはAdobe PDFドキュメントのプロパティ画面で見ることができます。
 
Adobe PDFドキュメントに埋め込むフォント名（JV_PDF_FONTEMBED）
Adobe PDFドキュメントの中にフォントを埋め込む時に使います。埋め込むことができるフォントは、True Typeフォントのみです。 指定しなかったフォントは、埋め込まれません。描画に使用するすべてのフォントを埋め込む場合は、 * を指定します。
指定したフォントファイルが、作成する環境にない場合には、「JV_ERR_FONTEMBED_FILE」が発生します。指定したフォントがTrue Typeフォント以外の場合にも、同じエラーが発生します。エラーの原因となったフォント名は、jvGetString で取得します。
 
ジャイブレポート外字ファイル名（JV_GAIJI_FILE）
jvStartDocの前でジャイブレポート外字ファイルの名前をフルパスで指定します。ジャイブレポート外字ファイルはレポートエディタで作成します。
 
プリントデータ型（JV_DOCUMENT_DATATYPE）
プリントデータ型は、コントロールパネルのプリンターのプロパティ詳細設定画面にあるプリントデータ型プロパティをアプリケーションから設定するための機能です。プリントデータ型は、コントロールパネルのプリンターのプロパティ詳細設定画面から設定することもできます。
指定可能なプリントデータ形式は、jvGetPrinterStringで取得することができます。コントロールパネルのプリンターのプロパティ詳細画面から取得することもできます。取得したデータ型のみ有効です。
jvSetStringで設定したプリントデータ型は、直後に印刷するドキュメントに対してのみ有効です。アプリケーションが終了しても有効となるように永久登録する場合には jvSetPrinterString関数を使用します。
RAW形式にする場合は"RAW"を指定します。EMF形式にする場合は"NT EMF 1.006"などを指定します。
イメージや２次元バーコード等が正しく印刷されない場合、RAW形式にすることによって現象が改善されることがあります。
jvStartDocの前に指定します。
 
−外字の描画
  
−Adobe PDFドキュメントへのフォント埋め込み
−Adobe PDFドキュメントのセキュリティ
   
[コーディング例]
 
Dim jid&, ret&
jid = jvCreate(JV_PRINTER, form1.hWnd, Printer.hDC, 0, 0, 0, "")
ret = jvSetString(jid, JV_PDF_OWNER_PASSWORD, "owner")
ret = jvSetString(jid, JV_PDF_USER_PASSWORD, "user")
ret = jvSetString(jid, JV_PDF_AUTHOR, "ジャイブコンピュータ")
ret = jvSetString(jid, JV_PDF_CREATOR, "確定申告書印刷プログラム")
ret = jvSetString(jid, JV_DOCUMENT_DATATYPE,"RAW")
 
ret = jvStartDoc(jid, "販売実績", "")
 
ret = jvSetString(jid, JV_IMAGE_PATH_NAME,"c:\temp")
ret = jvSetString(jid, JV_REPLACE_CHAR, "*")
ret = jvSetString(jid, JV_GRID_SEPARATOR, ",")
ret = jvSetString(jid, JV_RDF_KEY1, "販売実績６月分")
ret = jvSetString(jid, JV_RDF_KEY2, "名古屋支店")
ret = jvSetString(jid, JV_PDF_BOOKMARK, "納品書")
ret = jvSetString(jid, JV_PDF_FONTEMBED, "MS 明朝")
ret = jvSetString(jid, JV_PDF_FONTEMBED, "*")
|
ret = jvEndPage(jid)
ret = jvEndDoc(jid)
ret = jvClose(jid)