COMインタフェース「PrComPrtコンポーネント」には、以下のメソッドがあります。
なお、異常が発生した場合、エラーは、環境設定画面の指定にかかわらず、イベントログに通知されます。
メソッド名 | 復帰値 | ||
|---|---|---|---|
帳票出力の実行 | PrintOut | 0：正常終了 | |
データファイルの生成 | データファイル生成 | StartData | 0：正常終了 |
データファイルにデータ出力 | DataWrite | 0：正常終了 | |
データファイル生成 | StopData | 0：正常終了 | |
データファイル生成 | EndData | 0：正常終了 | |
OWFファイルの生成 | GenerateOwf | 0：正常終了 | |
外字フォントファイルの登録 | SetOwfRegFont | 0：正常終了 | |
SetOwfRegFontCollection | 0：正常終了 | ||
*1：
JobWaitプロパティに「TRUE」を指定し、帳票の出力完了を待ち合わせているときに異常が発生した場合に、-101～-108で復帰します。
復帰値 | 意味 |
|---|---|
-101 | スプールドキュメントが削除されました。 |
-102 | スプールドキュメントが保留されました。 |
-103 | 出力装置がオフライン、またはストップ状態のため、帳票を出力することができませんでした。 |
-104 | 出力装置が用紙切れのため、帳票を出力することができませんでした。 |
-105 | 出力装置がエラー状態のため、帳票を出力することができませんでした。 |
-106 | リモート出力装置へスプールドキュメントを転送中にエラーが発生しました。 |
-107 | 出力後保存中にエラーが発生しました。 |
-108 | 用紙交換メッセージ、または出力開始メッセージ応答待ち状態のため、出力完了待ち合わせが解除されました。 |
以下に、PrintOutメソッドについて説明します。
設定された各プロパティにしたがって帳票出力を実行します。
object.PrintOut
PrintOutメソッドの構文は、次の指定項目から構成されます。
指定項目 | 内容 |
|---|---|
object（必ず指定します） | PrComPrtオブジェクトを指定します。 |
以下に、メソッドの呼び出し例（VBScript）を示します。
<%
Dim prcomprt
Set prcomprt = CreateObject(" PrCom.PrComPrt" )
prcomprt.ScriptFile= "売上伝票"
prcomprt.DataFile= "C:\ListCREATOR\Data\売上伝票.dat"
prcomprt.PrintOut
%>以下に、StartDataメソッド、DataWriteメソッド、StopDataメソッド、およびEndDataメソッドについて説明します。
DataFileプロパティに指定するデータファイルをプログラム中で動的に生成します。
object.StartData
object.DataWrite(recordData)
object.StopData
object.EndData
各メソッドの構文は、次の指定項目から構成されます。
指定項目 | 内容 |
|---|---|
object（必ず指定します） | PrComPrtオブジェクトを指定します。 |
recordData | 1レコード（行）を1回の単位としたデータを指定します。 |
ポイント
StartData/DataWrite/EndDataメソッドを呼び出して動的にデータファイルを生成した場合、アプリケーションでは、DataFileプロパティを指定する必要はありません。DataFileプロパティを指定しても、無効となります。
StartDataメソッド を呼び出した場合は、必ずEndDataメソッドを呼び出してください。
動的に生成したデータファイルは、COMインタフェース「PrComPrtコンポーネント」が破棄されるときに自動的に削除されます。
DataWriteメソッドの引数で指定するデータファイル（入力データ）の指定形式、および注意事項については、オンラインマニュアル“帳票設計編”のデータファイルについての記載を参照してください。
DataWriteメソッドでは、Shift-JISの文字列データを指定してください。
データファイルの生成は次のように行います。
まず、StartDataメソッドを引数なしで呼び出します。
次に、DataWriteメソッドを呼び出し、データをセットしていきます。この時、データの形式は、1レコード（行）を1回の単位とします。
データを渡し終えた時点でEndDataメソッドを呼び出します。
データファイルの生成処理を中断する場合は、StopDataメソッドを呼び出します。この場合、EndDataメソッドを呼び出す必要はありません。
以下に、メソッドの呼び出し例（VBScript）を示します。
帳票出力を実行する場合
<%
Dim prcomprt
Set prcomprt = CreateObject(" PrCom.PrComPrt" )
prcomprt.ScriptFile = "売上伝票"
prcomprt.StartData
prcomprt.DataWrite "0020|カラーテレビ|3|120000|1234567890|1.234"
prcomprt.DataWrite "0022|カラオケセット|1|82000|1234567890|1.234"
prcomprt.EndData
prcomprt.PrintOut
%>OWFファイルを生成する場合
<%
Dim prcomprt
Set prcomprt = CreateObject(" PrCom.PrComPrt" )
prcomprt.ScriptFile = "売上伝票"
prcomprt.StartData
prcomprt.DataWrite "0020|カラーテレビ|3|120000|1234567890|1.234"
prcomprt.DataWrite "0022|カラオケセット|1|82000|1234567890|1.234"
prcomprt.EndData
prcomprt.GenerateOwf " 生成するOWFファイルのフルパス文字列"
%>以下に、GenerateOwfメソッドについて説明します。
設定された各プロパティにしたがってOWFファイルを生成します。
object.GenerateOwf(owfPath)
各メソッドの構文は、次の指定項目から構成されます。
指定項目 | 内容 |
|---|---|
object（必ず指定します） | PrComPrtオブジェクトを指定します。 |
owfPath | 生成するOWFファイルのフルパスを指定します。 |
設定された各プロパティにしたがってOWFファイルを生成します。
指定されたOWFファイルがすでに存在する場合はエラーとなります。したがって、生成されたOWFファイルが不要になったときは、利用者が任意で削除する必要があります。
以下に、メソッドの呼び出し例（VBScript）を示します。
<%
Dim prcomprt
Set prcomprt = CreateObject(" PrCom.PrComPrt" )
prcomprt.ScriptFile= "売上伝票"
prcomprt.DataFile= "C:\ListCREATOR\Data\売上伝票.dat"
prcomprt.GenerateOwf "生成するOWFファイルのフルパス文字列"
%>以下に、SetOwfRegFontメソッドおよびSetOwfRegFontCollectionメソッドについて説明します。
任意のフォルダに格納されている外字フォントファイルを登録します。
object.SetOwfRegFont(ttfpath, ttepath)
object.SetOwfRegFontCollection(ttcpath, ttepath, order)
各メソッドの構文は、次の指定項目から構成されます。
指定項目 | 内容 |
|---|---|
object（必ず指定します） | PrComPrtオブジェクトを指定します。 |
ttfpath | フォントファイル（TTFファイルまたはTTCファイル）へのフルパスを指定します。 |
ttepath | 登録する外字フォントファイル（TTEファイル）へのフルパスを指定します。 |
order | TTCファイルを登録するときは、TTCファイル内の何番目の書体を登録するかを指定します。 先頭の書体を登録する場合は、「1」を指定します。 |
任意のフォルダに格納されている外字フォントファイルを登録します。
このメソッドによる外字フォントファイルの登録は、以下のような場合に使用します。
「OWFファイルフォント登録」画面で登録されていないフォントの外字をエンベッドしたい場合
「OWFファイルフォント登録」画面で登録されているフォントの外字を一時的に異なる外字に変更し、変更した外字をエンベッドしたい場合
このメソッドの呼び出しを省略する、またはこのメソッドで登録されなかったフォントについては、「OWFファイルフォント登録」画面で登録したフォントが有効になります。
以下に、このメソッドを使用する場合の注意事項を示します。
複数の外字フォントファイルを登録したい場合は、このメソッドを複数回、呼び出してください。
ただし、同じフォントファイルに対して複数回指定した場合は、最後に指定した外字フォントファイルが有効になります。
SetOwfRegFontメソッドを指定する場合、ttfpathパラメータにTTCファイルを指定することはできません。指定した場合、エラーとなります。
SetOwfRegFontCollectionメソッドを指定する場合、ttcpathパラメータにTTFファイルを指定することはできません。指定した場合、エラーとなります。
外字フォントファイル名が同一で格納先が異なる指定は行わないでください。
以下に、メソッドの呼び出し例（VBScript）を示します。
<%
Dim prcomprt
Set prcomprt = CreateObject(" PrCom.PrComPrt" )
prcomprt.ScriptFile= "売上伝票"
prcomprt.DataFile= "C:\ListCREATOR\Data\売上伝票.dat"
prcomprt.OwfEmbedEUDC = 1
prcomprt.SetOwfRegFont "C:\Fonts\min.ttf" ,"C:\Fonts\mingaiji.tte"
prcomprt.SetOwfRegFontCollection "C:\Fonts\got.ttc" ,"C:\Fonts\gotgaiji.tte" , 2
prcomprt.GenerateOwf "生成するOWFファイルのフルパス文字列"
%>