STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

VB 開発向け

OCX リファレンス

おことわり
・本書の内容の全部または一部を、当社に無断で転載あるいは複製することは、法令に別段の定めがある場合を除き、固く禁じられています。
・本書の内容は、本製品の改良のため、将来予告なく変更することがあります。
・本書の内容については万全を期して制作しておりますが、万一わかりにくい点や記載漏れなどお気付きの点がございましたら、メガソフト株式会社サポートセンターまでご連絡ください（本書の内容と現実が異なるときは、現実が本書に優先します）。
・本製品を使用したことによるお客様の損害、逸失利益、または第三者のいかなる請求につきましても、当社は一切その責任を負いかねますので、あらかじめご了承ください。
・本製品をご使用になるには、製品パッケージ同梱の「ソフトウェア使用許諾条項」にご同意いただくことが必要です。

商標について・STARFAX はメガソフト株式会社の登録商標です。
・その他、製品名等は一般に各社の商標または登録商標です。
1

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

はじめに
STARFAX Server SDK の OCX（ActiveX）コントロールを利用したユーザープログラムの開発を行う上で、必要な操作方法などを収録のサンプルプログラムを用いて解説しています。
本マニュアルでは、Visual Basic 6.0 を開発ツールを主に説明しています。

STARFAX Server SDK に収録しているマニュアル一覧
・セットアップマニュアル
STARFAX Server SDK のセットアップ、環境設定や各種機能について説明しています。
STARFAX Server SDK をご使用の前に必ずご一読ください。
・ファイル de ＦＡＸマニュアル
STARFAX Server SDK の FAX 送受信は、STARFAX Server SDK が定めた書式のファイルを所定のフォルダに作成することで行ない、この仕組みを「ファイル de ＦＡＸ」といいます。
「ファイル de ＦＡＸ」で使用する各種ファイルの書式や、ファイルの取り扱いについて説明しています。

・VB（Visual Basic）開発向けマニュアル
Visual Basic を開発ツールとして、STARFAX Server SDK を利用するプログラムの作成の際には、以下のマニュアルをご参照ください。
・VB 開発向け OCX プログラミングマニュアル
・VB 開発向け OCX リファレンスマニュアル（本書）
・VB 開発向け プリンタドライバとビューア プログラミング＆リファレンスマニュアル
・VB 開発向け クライアント送信プログラミングマニュアル・VC（Visual C++）開発向けマニュアル
Visual C++ を開発ツールとして、STARFAX Server SDK を利用するプログラムの作成の際には、以下のマニュアルをご参照ください。
・VC 開発向け プログラミングマニュアル
・VC 開発向け プリンタドライバとビューア プログラミング＆リファレンスマニュアル
・VC 開発向けクライアント送信 プログラミングマニュアル

マニュアルでの表記

メニュー・設定項目などの表記
表記例

説

明

「メニュー名」「フォルダ名」「ファイル名」

メニュー名やファイル名、フォルダ名は「」で囲んであります。

[OK] [ キャンセル ]ボタン名は [] で囲んであります。

①②③…

操作手順の順番を表します。

本書で使用するアイコン
アイコン

説

明

使用上の補足事項を説明しています。
関連情報が掲載されているページを示しています。
マニュアル名がない場合は、本書内のページです。
使用にあたっての注意点を記載しています。

2

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

ご使用になる前にSTARFAX Server SDK OCX コントロールを使った開発を行う前に、STARFAX Server SDK のセットアップや基本設定を行う必要があります。
はじめに、以下の点をご確認ください。

[1] STARFAX Server SDK の準備

動作環境を確認する
STARFAX Server SDK をインストールするパソコンの動作環境をご確認ください。
特に対応 OS 以外では、インストールができても正常に動作しない場合があります。
「セットアップマニュアル」P5「ご利用前にご確認いただくこと」

STARFAX Server SDK のセットアップ
STARFAX Server SDK 本体のプログラムをセットアップします。
「セットアップマニュアル」P9「セットアップする」[2] STARFAX Server SDK の設定

STARFAX Server SDK の基本設定を行う
FAX の送受信を実際に行うためには、STARFAX Server SDK の基本設定を行い、サービスを開始します。
「セットアップマニュアル」P16「FAX モデムと、送受信のための設定」「セットアップマニュアル」P21「STARFAX Server SDK のサービスを開始 / 停止する」[3] OCX プログラムでできること
STARFAX Server SDK OCX の基本的な動作について説明します。

・STARFAX Server SDK へ動作を指示する
FAX の送信FAX 情報の削除指定した送受信結果を削除します。
ファイルの印刷
指定したファイルを印刷します。
メールの送信宛先、件名、添付ファイルなどを指定してメール送信します。

・STARFAX Server SDK の情報を参照、取得する
FAX 情報送受信ログの情報を参照します。
FAX 情報の追加、削除状況
送受信ログに追加、削除された差分情報を参照、取得します。
STARFAX Server SDK の各種情報
宛 TARFAX Server SDK の起動状況や、バージョン情報を参照します。

3

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

STARFAX Server SDK の状況を知る
STARFAX Server SDK の設定、動作状況を取得します。

サンプルプログラム【MonEnv.exe】●保存場所※下表の「保存する場所」の＜ OS フォルダ＞部分は、お使いの Windows により異なります。
＜ Windows 8、7、Vista、Server 2012/2012 R2、2008 /2008 R2 ＞
C:\Users\Public\Documents＜ Windows XP、Server 2003 /2003 R2 ＞
C:\Documents and Settings\All Users\Documents
プログラム\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\MonEnv.exe

開発プロジェクト\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\MonEnv\●サンプルプログラムの仕様
必須情報

STARFAX Server SDK のサービスを開始します。

回線

サンプルプログラムでは、回線 1~4 までの状況のみ表示しています。

●操作方法① STARFAX Server SDK のサービスを開始します。
「セットアップマニュアル」P21② サンプルプログラム「MonEnv.exe」を実行します。
③ 以下情報を参照します。

[1][1] サービス
サービスの動作状況を表示します。

[2][2] バージョン
STARFAX Server SDK のバージョン情報を表示し
ます。

[3]

[3] 自動削除
STARFAX Server SDK のログの自動削除設定状況を表示します。

[4][4] 回線
設定している回線のモデムドライバ、送受信設定
状況を表示します。

[5][5] 警告STARFAX Server SDK で発生しているイベント情報を表示します。
[6] 更新ボタン
最新の情報に更新します。

[6]

4

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
SFCSEnv コントロール メソッド一覧
メソッド名

詳

CheckInstall

STARFAX Server SDK のインストール状況、レジストリ、各種フォルダの状況を確認します。

CheckSubFolder

コントロール、データフォルダのサブフォルダの状況を確認します。

CheckServiceStatus

サービスの動作状況を確認します。

GetSfcsFolder

インストールフォルダのパスを取得します。

GetCtrlFolder

コントロールフォルダのパスを取得します。

GetDataFolder

データフォルダのパスを取得します。

GetSubFolder

コントロールフォルダ、データフォルダ内のサブフォルダのパスを取得します。

GetRunInfoString

起動情報ファイル内の項目を指定して、文字列の情報を取得します。
「STARFAX Server SDK ファイル de FAX」P22

GetRunInfoInt

細起動情報ファイル内の項目を指定して、数値の情報を取得します。

5

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

メソッドの仕様[SFCSMonEnv] コントロールの各メソッドの仕様について説明します。

CheckInstall メソッド
▋構文
Function CheckInstall( ) as Long

▋解説
STARFAX Server SDK のインストール、レジストリの登録情報、各フォルダ状況を確認します。

▋引数
なし

▋戻り値
戻り値

説

明

0

インストールされています。
SFCSENV_SUCCESS

1

インストールフォルダがレジストリに設定されていません。
SFCSENV_ERR_NoRegInstall2

インストールフォルダが存在しません。
SFCSENV_ERR_NoInstall3

コントロールフォルダがレジストリに設定されていません
SFCSENV_ERR_NoRegCtrl

4

コントロールフォルダが存在しません。
SFCSENV_ERR_NoCtrl

5

データフォルダがレジストリに設定されていません。
SFCSENV_ERR_NoRegData6

データフォルダが存在しません。
SFCSENV_ERR_NoData▋参照モジュール
SFCSEnvDef.bas

6STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
CheckSubFolder メソッド
▋構文
Function CheckSubFolder( Mode As Long// 確認するサブフォルダを指定 ) as Long

▋解説
STARFAX Server SDK のコントロールフォルダ、データフォルダの指定されたサブフォルダの状況を確認します。

▋引数
パラメータ

値

説

明

Mode

"SFCSENV_SMODE_SENDMIS"

状況を確認するサブフォルダを指定します。
SFCSENV_SMODE_SENDMIS(0)

送信命令フォルダ

SFCSENV_SMODE_RECVINFO(1)

受信情報フォルダ

SFCSENV_SMODE_SENDINFO(2)

送信情報フォルダ

SFCSENV_SMODE_QUEINFO(3)

未送信情報フォルダ

SFCSENV_SMODE_RECVDELMIS(4)

受信情報削除命令フォルダ

SFCSENV_SMODE_SENDDELMIS(5)

送信情報削除命令フォルダ

SFCSENV_SMODE_QUEDELMIS(6)

未送信情報削除命令フォルダ

SFCSENV_SMODE_PRTMIS(7)

印刷命令フォルダ

SFCSENV_SMODE_EMSMIS(8)

メール送信命令フォルダ

SFCSENV_SMODE_RECVADDNOTI(9)

受信情報追加済み通知フォルダ

SFCSENV_SMODE_SENDADDNOTI(10) 送信情報追加済み通知フォルダ

SFCSENV_SMODE_RECVDELNOTI(11) 受信情報削除済み通知フォルダ

SFCSENV_SMODE_SENDDELNOTI(12) 送信情報削除済み通知フォルダ

▋戻り値
戻り値

説

明

0

存在します。
SFCSENV_SUCCESS

3

コントロールがレジストリに設定されていません。
SFCSENV_ERR_NoRegCtrl

4

コントロールフォルダが存在しません。
SFCSENV_ERR_NoCtrl

7

フォルダが存在しません。
SFCSENV_ERR_NoFolder

100

パラメータエラー：サブフォルダの指定に誤りがあります。
SFCSENV_ERR_PARAM_MODE▋参照モジュール
SFCSEnvDef.bas

7STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
CheckServiceStatus メソッド
▋構文
Function CheckServiceStatus() as Long

▋解説
STARFAX Server SDK のサービス稼働状況を取得します。

▋引数
なし

▋戻り値
戻り値

説

明

0

停止中
SFCSENV_SERVICE_STOP

1

サービスモード動作中
SFCSENV_SERVICE_SERVICE

2

非サービスモード動作中
SFCSENV_SERVICE_TRAY▋参照モジュール
SFCSEnvDef.bas

GetSfcsFolder メソッド
▋構文
Function GetSfcsFolder( Get As String// フォルダパスを格納するための変数) as Long▋解説
STARFAX Server SDK のプログラムフォルダのパスを取得します。
※パスの最後に「￥」はつきません

▋引数
パラメータ

値

説

Get

明

インストールフォルダパスを格納するための変数

▋戻り値
戻り値

説

明

0

取得成功
SFCSENV_SUCCESS

0 以外

取得失敗
SFCSENV_SUCCESS 以外▋参照モジュール
SFCSEnvDef.bas
8STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
GetCtrlFolder メソッド
▋構文
Function GetCtrlFolder( Get As String// フォルダパスを格納するための変数) as Long▋解説
STARFAX Server SDK のコントロールフォルダのパスを取得します。
※パスの最後に「￥」はつきません

▋引数
パラメータ

値

説

Get

明

コントロールフォルダのパスを格納するための変数

▋戻り値
戻り値

説

明

0

取得成功
SFCSENV_SUCCESS

0 以外

取得失敗
SFCSENV_SUCCESS 以外▋参照モジュール
SFCSEnvDef.bas

GetDataFolder メソッド
▋構文
Function GetDataFolder( Get As String// フォルダパスを格納するための変数) as Long▋解説
STARFAX Server SDK のデータフォルダのパスを取得します。
※パスの最後に「￥」はつきません

▋引数
パラメータ

値

説

Get

明

データフォルダのパスを格納するための変数

▋戻り値
戻り値

説

明

0

取得成功
SFCSENV_SUCCESS

0 以外

取得失敗
SFCSENV_SUCCESS 以外▋参照モジュール
SFCSEnvDef.bas
9STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
GetSubFolder メソッド
▋構文
Function GetSubFolder( Mode As Long,
Get As String) as Long// 情報を取得するフォルダを指定// フォルダパスを格納するための変数▋解説
STARFAX Server SDK のサブフォルダを指定して、そのフォルダパスを取得します。
※パスの最後に「￥」はつきません

▋引数
パラメータ

値

説

Mode

"SFCSENV_SMODE_SENDMIS"

状況を確認するサブフォルダを指定します。

Get

明

SFCSENV_SMODE_SENDMIS(0)

送信命令フォルダ

SFCSENV_SMODE_RECVINFO(1)

受信情報フォルダ

SFCSENV_SMODE_SENDINFO(2)

送信情報フォルダ

SFCSENV_SMODE_QUEINFO(3)

未送信情報フォルダ

SFCSENV_SMODE_RECVDELMIS(4)

受信情報削除命令フォルダ

SFCSENV_SMODE_SENDDELMIS(5)

送信情報削除命令フォルダ

SFCSENV_SMODE_QUEDELMIS(6)

未送信情報削除命令フォルダ

SFCSENV_SMODE_PRTMIS(7)

印刷命令フォルダ

SFCSENV_SMODE_EMSMIS(8)

メール送信命令フォルダ

SFCSENV_SMODE_RECVADDNOTI(9)

受信情報追加済み通知フォルダ

SFCSENV_SMODE_SENDADDNOTI(10)

送信情報追加済み通知フォルダ

SFCSENV_SMODE_RECVDELNOTI(11)

受信情報削除済み通知フォルダ

SFCSENV_SMODE_SENDDELNOTI(12)

送信情報削除済み通知フォルダ

データフォルダのパスを格納するための変数

▋戻り値
戻り値

説

明

0

取得成功
SFCSENV_SUCCESS

0 以外

取得失敗
SFCSENV_SUCCESS 以外▋参照モジュール
SFCSEnvDef.bas

10STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
GetRunInfoString メソッド
▋構文
Function GetRunInfoString ( Section As String,
Key As String,
Default As String,
Get As String) as Long// セクション名を指定// 項目名を指定// デフォルト文字列// 文字列を格納するための変数▋解説
STARFAX Server SDK の起動情報ファイルから、セクション名、項目を指定して情報を取得します。
起動情報ファイル

▋引数
パラメータ

値

説

明

Section"StarFax"

情報を取得するセクション名を指定します。

Key"Acount"

情報を取得する項目名を指定します。

Default

指定したパラメータ「Section」「Key」が存在しなかった場合、どういう値を返すか ( デフォルトとすべきか ) を指定します

Get

文字列を格納するための変数

▋戻り値
戻り値

説

明

0

取得成功
SFCSENV_SUCCESS

0 以外

取得失敗
SFCSENV_SUCCESS 以外▋参照モジュール
SFCSEnvDef.bas

11STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

FAX を送信する
STARFAX Server SDK で FAX 送信をするには、相手先に送信する「送付状」または「FAX 原稿」と、送信先の情報と送信するファ
イルの場所を各メソッドで指定します。
プログラム例をサンプルプログラムのソースファイルをもとに説明します。

サンプルプログラム【SendFax.exe】●保存場所※下表の「保存する場所」の＜ OS フォルダ＞部分は、お使いの Windows により異なります。
＜ Windows 8、7、Vista、Server 2012/2012 R2、2008 /2008 R2 ＞
C:\Users\Public\Documents＜ Windows XP、Server 2003 /2003 R2 ＞
C:\Documents and Settings\All Users\Documents
プログラム\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\SendFax.exe

開発プロジェクト\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\SendFax\●サンプルプログラムの仕様
必須情報

・相手先の FAX 番号・送付状、または FAX 原稿のファイル

相手先

最大４件まで指定可能

送付状

テキスト形式のファイル「送付状を作成する」P7
最大４つのファイルまで指定可能
送信時に１ファイルに連結します。

原稿「送信原稿を指定する」

発信元情報

発信元情報を指定します。
ページヘッダーを使用する、相手先に表示させる FAX ID 番号を設定できます。

その他指定送信する回線の指定 ( 複数回線制御時に有効 )、割り込み送信、時間指定送信を指定できます。

●操作方法① STARFAX Server SDK のサービスを開始します。
「セットアップマニュアル」P21② サンプルプログラム「SendFax.exe」を実行します。
③ 以下の設定を行います。
[1] 相手先FAX を送信する相手の情報を入力します。
FAX 番号は必須です。
他の項目は送付状やページヘッダ情報を使用する際に必要となります。
サンプルプログラムでは画面上部のプルダウンメニューをクリックすることで、最大４件の相手先情報を入力できます。

[2] 原稿

相手先に送信する FAX 原稿のファイルパスを指定します。
サンプルプログラムでは最大４ファイルまで指定できます。
送信する際に指定したファイルを１ファイルにコンバートし、保存します。
※送付状を指定しない場合は、必ず原稿を指定します。

[1]
[2]
[3]
[4]
[5]

[6]

[3] 送付状

送付状を指定します。
フォントの形式、サイズを指定できます。
[1] で入力した会社名などの情報が指定した送付状内に差し込まれます。
※原稿を指定しない場合は、必ず送付状を指定します。

[4] 発信元情報

送付状や、ページヘッダ情報に差し込む送り元の情報を設定します。

12

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル[5] その他指定発信する回線、送信を実行する時刻の指定や他の FAX より優先させる設定を行います。
④ [6] 送信ボタンを押下し、設定した内容で FAX の送信命令を確定します。
送信結果は、ログ管理プログラムで確認します。
「セットアップマニュアル」P22

SFCSSendFax コントロール メソッド一覧
メソッド名

詳

細

AddSendInfo

相手先情報リスト 追加設定

AddSendInfoEx

相手先情報リスト 追加設定 ( 送信オプション拡張版 )ResetSendInfo

相手先情報リスト リセット

AddDocInfo

送信原稿リスト 追加設定

ResetDocInfo

送信原稿リスト リセット

SetDocInfoParam

相手先情報動作パラメータ設定

MakeSendMission

FAX 送信命令ファイル作成し、STARFAX Server SDK に送信を指示

MakeSendMissionEx

送付状をつけて FAX 送信する際に使用

MakeSendMissionToSharedFolder

共有フォルダ形式の送信命令ファイル作成

MakeTransFileForMailToFax[ メール de FAX ] の送信命令ファイル作成

SetupPrinter

FAX 送信用の TIFF ファイルの作成準備

TerminatePrinter

FAX 送信用の TIFF ファイルの作成終了

13

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

メソッドの仕様[ SFCSSendFax ] コントロールの各メソッドの仕様について説明します。

AddSendInfo メソッド
▋解説
FAX を送信する相手先の情報を指定します。
その他 通信する際の速度、圧縮方式、エラー訂正機能の有無を指定できます。

▋構文
Function AddSendInfo( Fax As String,Company As String,
Division As String,
Position As String,
Name As String,
Title As String,
Telephone As String,
ZipCode As String,
Address1 As String,
Address2 As String,
FCode As String,
FreeArea As String,
Speed As Integer,
Comp As Integer,
Ecm As Integer) as Long// 相手先 FAX 番号// 相手先 会社名// 相手先 所属名// 相手先 役職名// 相手先 氏名// 敬称// 相手先 電話番号// 相手先 郵便番号// 相手先 住所 1// 相手先 住所 2//F コードの設定// ユーザーフリーエリア// 通信速度の指定// 圧縮方式の指定// エラー訂正機能の指定▋パラメータ
パラメータ

値

説

明

Fax

"01-1234-5678"

FAX 番号を指定します

Company"MEGASOFT"

会社名を指定します

Division" 営業部 "

所属名を指定します

Position" ●●担当 "役職名を指定しますName" メガ 太郎 "氏名を指定します

Title

"様"

敬称を指定しますTelephone"02-1234-5678"

電話番号を指定します

ZipCode"123-4567"

郵便番号を指定します

Address1"( 住所 1)"

住所 1 を指定します

Address2"( 住所 2)"

住所 2 を指定します

FCode"(F コード )"Ｆコード番号を指定します

FreeArea""

ユーザが自由に利用できるエリア

Speed

SFCSSENDFAX_SPEED_AUTO

通信速度を指定します。
以下の値を指定できます。

SFCSSENDFAX_SPEED_AUTO (0) 自動
SFCSSENDFAX_SPEED_HIGHT (1) 高速
SFCSSENDFAX_SPEED_MIDDLE (2) 中速
SFCSSENDFAX_SPEED_LOW(3) 低速14

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
パラメータ

値

説

明

Comp

SFCSSENDFAX_COMP_AUTO

圧縮方式を指定します。
以下の値を指定できます。

SFCSSENDFAX_COMP_AUTO (0) 自動
SFCSSENDFAX_COMP_MH(1) MHSFCSSENDFAX_COMP_MR(2) MRSFCSSENDFAX_COMP_MMR (3) MMR

Ecm

SFCSSENDFAX_ECM_AUTO

エラー訂正を指定します。
以下の値を指定できます。

SFCSSENDFAX_ECM_AUTO(0) 自動SFCSSENDFAX_ECM_ENABLE (1) 利用する
SFCSSENDFAX_ECM_DISABLE (2) 利用しない

▋戻り値
戻り値

説

明

0

追加成功
SFCSSENDFAX_SUCCESS

0 以外

追加失敗
SFCSSENDFAX_SUCCESS 以外▋参照モジュール
SFCSSendFaxDef.bas

AddSendInfoEX メソッド
▋解説
送信する FAX の相手先情報を指定します。
その他 通信する際の速度、圧縮方式、エラー訂正機能、送信する時刻、回線、優先順位が指定できます。

▋構文
Function AddSendInfoEX( Fax As String,Company As String,
Division As String,
Position As String,
Name As String,
Title As String,
Telephone As String,
ZipCode As String,
Address1 As String,
Address2 As String,
FCode As String,
FreeArea As String,
Speed As Integer,
Comp As Integer,
Ecm As Integer,Line As Integer,
Priority As Integer,
Time As String) as Long// 相手先 FAX 番号// 相手先 会社名// 相手先 所属名// 相手先 役職名// 相手先 氏名// 敬称// 相手先 電話番号// 相手先 郵便番号// 相手先 住所 1// 相手先 住所 2// F コードの設定// ユーザーフリーエリア// 通信速度の指定// 圧縮方式の指定// エラー訂正機能の指定// 送信する回線の指定// 優先度の指定// 送信開始時刻の指定

15

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
▋引数
パラメータ

値

説

明

Fax

"01-1234-5678"

FAX 番号を指定します

Company"MEGASOFT"

会社名を指定します

Division" 営業部 "

所属名を指定します

Position" ●●担当 "役職名を指定しますName" メガ タロウ "氏名を指定します

Title

"様"

敬称を指定しますTelephone"02-1234-5678"

電話番号を指定します

ZipCode"123-4567"

郵便番号を指定します

Address1"( 住所 1)"

住所 1 を指定します

Address2"( 住所 2)"

住所 2 を指定します

FCode"(F コード )"Ｆコード番号を指定します

FreeArea""

ユーザが自由に利用できるエリア

Speed

SFCSSENDFAX_SPEED_AUTO

通信速度を指定します。
以下の値を指定できます。

SFCSSENDFAX_SPEED_AUTO (0) 自動
SFCSSENDFAX_SPEED_HIGHT (1) 高速
SFCSSENDFAX_SPEED_MIDDLE (2) 中速
SFCSSENDFAX_SPEED_LOW(3) 低速CompSFCSSENDFAX_COMP_AUTO

圧縮方式を指定します。
以下の値を指定できます。

SFCSSENDFAX_COMP_AUTO (0) 自動
SFCSSENDFAX_COMP_MH(1) MHSFCSSENDFAX_COMP_MR(2) MRSFCSSENDFAX_COMP_MMR (3) MMR

Ecm

SFCSSENDFAX_ECM_AUTO

エラー訂正を指定します。
以下の値を指定できます。

SFCSSENDFAX_ECM_AUTO(0) 自動SFCSSENDFAX_ECM_ENABLE (1) 利用する
SFCSSENDFAX_ECM_DISABLE (2) 利用しない

Line

SFCSSENDFAX_LINE_NO

Priority

SFCSSENDFAX_PRIORITY_NO

優先度を指定します。
以下の値を指定できます。

SFCSSENDFAX_PRIORITY_NO 指定なし※初期値 8
SFCSSENDFAX_PRIORITY_0 優先度低SFCSSENDFAX_PRIORITY_1
SFCSSENDFAX_PRIORITY_2
SFCSSENDFAX_PRIORITY_3↑
SFCSSENDFAX_PRIORITY_4
SFCSSENDFAX_PRIORITY_5
SFCSSENDFAX_PRIORITY_6
SFCSSENDFAX_PRIORITY_7
SFCSSENDFAX_PRIORITY_8
標準SFCSSENDFAX_PRIORITY_9
SFCSSENDFAX_PRIORITY_10
SFCSSENDFAX_PRIORITY_11
SFCSSENDFAX_PRIORITY_12↓
SFCSSENDFAX_PRIORITY_13
SFCSSENDFAX_PRIORITY_14
SFCSSENDFAX_PRIORITY_15 優先度高Time

"201302081030"

送信開始時刻の指定
左は「2013 年 2 月 8 日 10：30」を指定した場合の値"YYYY( 年 ) MM( 月 )DD( 日 )MM( 時 )SS( 分 )”16

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
▋戻り値
戻り値

説

明

0

追加成功

SFCSSENDFAX_SUCCESS

0 以外

追加失敗

SFCSSENDFAX_SUCCESS 以外▋参照モジュール
SFCSSendFaxDef.bas

ResetSendInfo メソッド▋構文
Sub ResetSendInfo()▋解説
MakeSendMission メソッド実行時、相手先情報リストをリセットします。

▋引数
なし

▋戻り値
なし

AddDocInfo メソッド
▋構文
Function AddDocInfo( DocName As String// 送信原稿のファイルパス ) as Long

▋解説
相手先に送信する原稿を指定します。

▋引数
パラメータ

値

説

明

DocName As String"C:\Genkou\Page1.tiff"

送信原稿のファイルパス

▋戻り値
戻り値

説

明

0

追加成功

SFCSSENDFAX_SUCCESS

0 以外

追加失敗

SFCSSENDFAX_SUCCESS 以外▋参照モジュール
SFCSSendFaxDef.bas
17STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
ResetDocInfo メソッド▋構文
Sub ResetDocInfo()▋解説
MakeSendMission メソッド 実行時、セットされている送信原稿リストをリセットします。

▋引数
なし

▋戻り値
なし

AddDocInfo メソッド
▋構文
Function SetDocInfoParam( Param As Integer// 処理後、送信原稿を削除) as Long▋解説
送信後、FAX 原稿の削除有無を設定します。

▋引数
パラメータ

値

説

明

Param

SFCSSENDFAX_DOCPAPAME_NO

処理後、送信原稿の削除有無を指定します。
以下の値を指定できます。
SFCSSENDFAX_DOCPAPAME_NO(0)
SFCSSENDFAX_DOCPAPAME_DELETE (1)

▋戻り値
戻り値

説

明

0

追加成功
SFCSSENDFAX_SUCCESS

0 以外

追加失敗
SFCSSENDFAX_SUCCESS 以外▋参照モジュール
SFCSSendFaxDef.bas

18

指定なし
処理後、削除する

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
MakeSendMission メソッド
▋構文
Function MakeSendMission( CoverName As String, // 送付状のファイルパス
// 発信元情報の記録
UserInfo As String,// 自局番号 (FAXID)
UserID As String,// アカウント ( フリーエリア )Acount As String) as Long▋解説
指定した相手先情報、送信原稿などから FAX 送信命令ファイルを作成します。
送信時の各種設定は以下のメソッドで行います。
・AddSendInfo / AddSendInfoEx メソッド
・AddDocInfo メソッド
・SetDocInfoParam メソッド

▋引数
パラメータ

値

説

明

CoverName"C:\Soufujo\Cover.txt"

送付状ファイル名

UserInfo"1,%S %N"

ページヘッダー情報を指定します。
指定方法： "< 記録位置 >,< 差し込む情報 >"以下の値が設定できます。
・記録位置
0
1
2

：記録しない
：原稿の内側に記録：原稿の外側に記録・差し込む情報 ( 最大 70 バイトまで )以下の値を入力すると、相手先情報が反映されます。

％ S ：相手先会社名％ N：相手先氏名 ( 敬称は自動で付加されます )％ T ：相手先 FAX 番号

UserID"06 1234 5678"

FAX ID( 相手機に通知されます ) を設定します。
「半角数字」「半角スペース」「+」を使用できます。
※最大 20 バイトまで

Acount"0000001"

アカウント

自由に利用できるエリア
ログに情報が引き継がれます。任意の情報を入力して、検索するといったことが可能
です。

▋戻り値
戻り値

説

明

0

正常終了
SFCSSENDFAX_SUCCESS

1

送信命令フォルダが存在しません
SFCSSENDFAX_ERR_NoMisFolder

2

送信命令フォルダの取得に失敗しました
SFCSSENDFAX_ERR_GetMisFolder

3

一時フォルダの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFolder

4

一時ファイルの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFile

19

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
戻り値

説

明

5

送信命令ファイル名の作成に失敗しました
SFCSSENDFAX_ERR_MakeMisName

100

送信命令ファイル作成情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_INFO

101

相手先情報がセットされていません。
SFCSSENDFAX_ERR_PARAM_SENDNUM

102

相手先情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_SENDINFO

103

FAX 番号が指定されていません。
SFCSSENDFAX_ERR_PARAM_FAX

104

送信原稿ファイル、送付状ファイルが指定されていません。
SFCSSENDFAX_ERR_PARAM_DOCorCOVER

105

送信原稿ファイル名が指定されていません。
SFCSSENDFAX_ERR_PARAM_DOCNAME▋参照モジュール
SFCSSendFaxDef.bas

MakeSendMissionEX メソッド
▋構文
Function MakeSendMissionEX( CoverName As String,
FontName As String,
FontSize As Integer,
UserInfo As String,
UserID As String,Acount As String) as Long// 送付状のファイルパス
// 送付状のフォント指定// 送付状のフォントサイズ指定// ページヘッダ情報の指定// 自局番号 (FAXID)// アカウント ( フリーエリア )▋解説
指定した相手先情報、送信原稿などから FAX 送信命令ファイルを作成します。
送付状のフォント名、サイズが指定できます。
送信時の各種設定は以下のメソッドで行います。
・AddSendInfo / AddSendInfoEx メソッド
・AddDocInfo メソッド
・SetDocInfoParam メソッド

▋引数
パラメータ

値

説

明

CoverName"C:\Soufujo\Cover.txt"

送付状ファイルパス

FontName"MSP ゴシック "送付状のフォント名指定がない場合は "MS ゴシックです "FontSize"10"

送付状のフォントサイズ ( 初期値：10 ポイント )8 ～ 72 ポイント内で指定します。
それ以外の数値を指定した場合 10 ポイントで設定されます。

20

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
パラメータ

値

説

明

UserInfo"1, メガソフト株式会社 "ページヘッダー情報を指定します。
指定方法： "< 記録位置 >,< 差し込む情報 >"以下の値が設定できます。
・記録位置
0
1
2

：記録しない
：原稿の内側に記録：原稿の外側に記録・差し込む情報 ( 最大 70 バイトまで )以下の値を入力すると、相手先情報が反映されます。

％ S ：相手先会社名％ N：相手先氏名 ( 敬称は自動で付加されます )％ T ：相手先 FAX 番号

UserID"06 1234 5678"

FAX ID( 相手機に通知されます ) を設定します。
「半角数字」「半角スペース」「+」を使用できます。
※最大 20 バイトまで

Acount"0000001"

アカウント

自由に利用できるエリア
ログに情報が引き継がれます。任意の情報を入力して、検索するといったことが可能
です。

▋戻り値
戻り値

説

明

0

正常終了
SFCSSENDFAX_SUCCESS

1

送信命令フォルダが存在しません
SFCSSENDFAX_ERR_NoMisFolder

2

送信命令フォルダの取得に失敗しました
SFCSSENDFAX_ERR_GetMisFolder

3

一時フォルダの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFolder

4

一時ファイルの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFile

5

送信命令ファイル名の作成に失敗しました
SFCSSENDFAX_ERR_MakeMisName

100

送信命令ファイル作成情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_INFO

101

相手先情報がセットされていません。
SFCSSENDFAX_ERR_PARAM_SENDNUM

102

相手先情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_SENDINFO

103

FAX 番号が指定されていません。
SFCSSENDFAX_ERR_PARAM_FAX

104

送信原稿ファイル、送付状ファイルが指定されていません。
SFCSSENDFAX_ERR_PARAM_DOCorCOVER

105

送信原稿ファイル名が指定されていません。
SFCSSENDFAX_ERR_PARAM_DOCNAME▋参照モジュール
SFCSSendFaxDef.bas

21STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
MakeSendMissionToSharedFolder メソッド
▋構文
Function MakeSendMissionToSharedFolder( SharedFolder As String, // 共有フォルダ
CoverName As String, // 送付状のファイルパス
// 送付状のフォント
FontName As String,// 送付状のフォントサイズ
FontSize As Integer,// ページヘッダ情報
UserInfo As String,// 発信元情報 (FAX ID)
UserID As String,// アカウント ( フリーエリア )Acount As String) as Long▋解説
STARFAX Server SDK をセットアップしていないパソコンで送信命令ファイルを作成し、FAX 送信を指示します。
送信命令フォルダを各ファイルが相対的に扱えるように、送信命令フォルダを共有設定します。
FAX 原稿、送付状などは送信命令フォルダ内に「作業フォルダ」としてサブフォルダが自動的に作られ、保存されます。
※ FAX 送信処理後は削除されます。
送信時の各種設定は以下のメソッドで行います。
・AddSendInfo / AddSendInfoEx メソッド
・AddDocInfo メソッド
・SetDocInfoParam メソッド

▋引数
パラメータ

値

説

明

SharedFolder"( 絶対パス )"共有設定を行った送信命令フォルダを指定します。

CoverName"C:\Soufujo\Cover.txt"

送付状のファイルパス

FontName"MSP ゴシック "送付状のフォント名を指定※初期値：MS ゴシック

FontSize"10"

送付状のフォントサイズ ( 初期値：10 ポイント )8 ～ 72 ポイント内で指定します。
それ以外の数値を指定した場合 10 ポイントで設定されます。

ページヘッダー情報を指定します。
指定方法："< 記録位置 >,< 差し込む情報 >"以下の値が設定できます。

UserInfo"1, メガソフト株式会社 "・記録位置
0 ：記録しない
1 ：原稿の内側に記録
2 ：原稿の外側に記録・差し込む情報 ( 最大 70 バイトまで )以下の値を入力すると、相手先情報が反映されます。
％ S ：相手先会社名％ N：相手先氏名 ( 敬称は自動で付加されます )％ T ：相手先 FAX 番号

UserID"06 1234 5678"

Acount"0000001"

FAX ID( 相手機に通知されます ) を設定します。
「半角数字」「半角スペース」「+」を使用できます。
※最大 20 バイトまで

アカウント

自由に利用できるエリア
ログに情報が引き継がれます。任意の情報を入力して、検索するといったことが可能です。

22

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
▋戻り値
戻り値

説

明

0

正常終了
SFCSSENDFAX_SUCCESS

3

一時フォルダの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFolder

4

一時ファイルの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFile

5

送信命令ファイル名の作成に失敗しました
SFCSSENDFAX_ERR_MakeMisName

30

共有フォルダが存在しません
SFCSSENDFAX_ERR_NoShareFolder

31

共有フォルダに送信原稿フォルダを作成できませんでした
SFCSSENDFAX_ERR_MakeShareDocFolder

32

共有フォルダに送信原稿をコピーできませんでした
SFCSSENDFAX_ERR_MakeShareDocFile

33

共有フォルダに送付状をコピーできませんでした
SFCSSENDFAX_ERR_MakeShareCvrFile

100

送信命令ファイル作成情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_INFO

101

相手先情報がセットされていません。
SFCSSENDFAX_ERR_PARAM_SENDNUM

102

相手先情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_SENDINFO

103

FAX 番号が指定されていません。
SFCSSENDFAX_ERR_PARAM_FAX

104

送信原稿ファイル、送付状ファイルともに指定されていません。
SFCSSENDFAX_ERR_PARAM_DOCorCOVER

105

送信原稿ファイル名が指定されていません。
SFCSSENDFAX_ERR_PARAM_DOCNAME

120

共有フォルダが指定されていません。
SFCSSENDFAX_ERR_PARAM_SHAREFOLDER▋参照モジュール
SFCSSendFaxDef.bas

23STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
MakeTransFileForMailToFax メソッド
▋構文
Function MakeTransFileForMailToFax( TransFile As String,
CoverName As String,
FontName As String,
FontSize As Integer,
UserInfo As String,
UserID As String) as Long// 送信命令ファイル// 送付状のファイル名// 送付状のフォント// 送付状のフォントサイズ// ページヘッダ情報// 発信元情報 (FAX ID)▋解説
メール機能を介して FAX 送信を指示します。
（Mail To FAX 機能 )
送信時の各種設定は以下のメソッドで行います。
・AddSendInfo / AddSendInfoEx メソッド

▋引数
パラメータ

値

説

明

TransFile"Trans.txt"

送信命令ファイル
INI 形式で書かれた拡張子 .TXT のファイルで指定します。
ファイル名は必ず「Trans.txt」で指定します。

CoverName"Cover.txt"

送付状ファイル名
送付状のファイル名を指定します。

FontName"MSP ゴシック "送付状のフォント名を指定

FontSize"10"※同名のファイルをメールに添付します。
※初期値：MS ゴシック

送付状のフォントサイズ ( 初期値：10 ポイント )8 ～ 72 ポイント内で指定します。
それ以外の数値を指定した場合 10 ポイントで設定されます。

ページヘッダー情報を指定します。
指定方法："< 記録位置 >,< 差し込む情報 >"以下の値が設定できます。

UserInfo"1, メガソフト株式会社 "・記録位置
0 ：記録しない
1 ：原稿の内側に記録
2 ：原稿の外側に記録・差し込む情報 ( 最大 70 バイトまで )以下の値を入力すると、相手先情報が反映されます。
％ S ：相手先会社名％ N：相手先氏名 ( 敬称は自動で付加されます )％ T ：相手先 FAX 番号

UserID"06 1234 5678"

FAX ID( 相手機に通知されます ) を設定します。
「半角数字」「半角スペース」「+」を使用できます。
※最大 20 バイトまで

▋戻り値
戻り値

説

明

0

正常終了
SFCSSENDFAX_SUCCESS

3

一時フォルダの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFolder

4

一時ファイルの取得に失敗しました
SFCSSENDFAX_ERR_GetTempFile
24

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
戻り値

説

明

20

送信命令ファイルの作成に失敗しました
SFCSSENDFAX_ERR_CreateTransFile

100

送信命令ファイル作成情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_INFO

101

相手先数の指定が 0 です。
SFCSSENDFAX_ERR_PARAM_SENDNUM

102

相手先情報が指定されていません。
SFCSSENDFAX_ERR_PARAM_SENDINFO

103

FAX 番号が指定されていません。
SFCSSENDFAX_ERR_PARAM_FAX

110

送信命令ファイルが指定されていません。
SFCSSENDFAX_ERR_PARAM_TRANSFILE▋参照モジュール
SFCSSendFaxDef.bas

SetupPrinter メソッド
▋構文
Function SetupPrinter() as Long// 作成後に保存するフォルダを指定
Folder As String,
FileName As String // 作成後のファイル名を指定▋解説
STARFAX Server SDK プリンタドライバで作成した TIFF ファイルを取得する準備をします。
メソッド実行後に STARFAX Server SDK プリンタドライバに対して印刷処理を行い、TerminatePrinter メソッドで作成されたTiff ファイルを取得します。

▋引数
パラメータ

値

説

明

Folder"C:\Genkou"

作成した Tiff ファイルを保存するフォルダパスを指定

FileName"Page1.tiff"

作成するファイル名を指定
ファイル名に「.Tiff」が含まれていない場合、自動的に付加されます。
未指定は、自動的にファイル名が生成されます。
※例：YYYYMMDDHHMMSS.tiff

▋戻り値
戻り値

説

明

0

正常終了
SFCSPRINTER_SUCCESS

1

フォルダが指定されていません。
SFCSPRINTER_ERR_PARAM_Folder

2

指定したフォルダが存在しません。
SFCSPRINTER_ERR_PARAM_NoFolder

25

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
戻り値

説

明

10

プリンタドライバ動作設定値 ( レジストリ ) エラー
このメソッドを正常に動作させるには、プログラム実行フラグを 0 にする必要があります。
SFCSPRINTER_ERR_REG_ExecFlag

11

プリンタドライバ動作設定値 ( レジストリ ) エラー
このメソッドを正常に動作させるには、ファイル出力フォルダを指定する必要があります。
SFCSPRINTER_ERR_REG_OutFolder

12

プリンタドライバ動作設定値 ( レジストリ ) エラー
ファイル出力フォルダに指定されているフォルダが存在しません。
SFCSPRINTER_ERR_REG_NoOutFolder

13

プリンタドライバ動作設定値 ( レジストリ ) エラー
ファイル出力フォルダに指定されているフォルダと TIFF ファイルを作成するフォルダが同じです。
SFCSPRINTER_ERR_REG_SameOutFolder

14

プリンタドライバ動作設定値 ( レジストリ ) エラー
ファイル出力フォルダ内のクリアに失敗しました。
SFCSPRINTER_ERR_REG_ClsOutFolder▋参照モジュール
SFCSPrinterDef.bas

TerminatePrinter メソッド
▋構文
Function TerminatePrinter( ) as String▋解説
SetupPrinter メソッド実行後に、STARFAX Server SDK プリンタドライバで作成した TIFF ファイルを取得します。

▋引数
なし

▋戻り値
戻り値

説

明

"C:\Geokou\Page1.tiff"

作成された Tiff ファイルを取得しました。

""

空白
Tiff ファイルの作成が完了していません。（作成途中の可能性があります）"NG"

SetupPrinter メソッドが実行されていない、または正常に終了できませんでした。

26

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

ログの参照と削除
STARFAX Server SDK の未送信ログを参照し、指定したログを削除します。

サンプルプログラム●保存場所※下表の「保存する場所」の＜ OS フォルダ＞部分は、お使いの Windows により異なります。
＜ Windows 8、7、Vista、Server 2012/2012 R2、2008 /2008 R2 ＞
C:\Users\Public\Documents＜ Windows XP、Server 2003 /2003 R2 ＞
C:\Documents and Settings\All Users\Documents
プログラム\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\MonLog.exe

開発プロジェクト\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\MonLog\●サンプルプログラムの仕様
参照

STARFAX Server SDK の送受信、未送信ログを一覧で表示します。
FAX 原稿はダブルクリック、または右クリックメニューの「ビューア」を指定し表示します。

削除

ログの削除は、特定のログを一覧から選択し、右クリックメニューから「削除」を選択します。

●操作方法① STARFAX Server SDK のサービスを開始します。
「セットアップマニュアル」P21② サンプルプログラム「MonLog.exe」を実行します。
[3]③ ログを参照します。
[1] 更新ボタン
最新のログ情報へ更新します。
[2] ログフォルダ
参照するログを選びます。

[1]

[2]
[3] ビューアボタン
一覧から選択されたログの原稿を表示します。
[4] ログ一覧[2] で選択したログフォルダの結果を一覧
で表示します。
④ 削除します。
[2] で参照するログの種類を選択します。
[4] から削除するログを右クリックし、表示されたメニューから「削除」を選択します。

27

[4]

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
SFCSLogQue( 未送信 ) SFCSLogSned ( 送信 ) SFCSLogRecv（受信 ) コントロール メソッド一覧
メソッド名

詳

細

Load

読み込み

Release

読み込み の終了処理

Reload

再読み込み

GetRecCount

レコード数の取得

GetRecItemString

指定した項目の文字列を取得

GetRecItemInt

指定した項目の値を取得

GetRecComStatus

通信状態を取得

ResetDelInfo

削除ジョブ ID リスト リセット

AddDelInfo

削除ジョブ ID リスト 追加設定

MakeDelMission

削除命令ファイルの作成※ SFCSLogQue( 未送信 ) コントロールのみ

メソッドの仕様SFCSLogQue( 未送信 ) SFCSLogSned ( 送信 ) SFCSLogRecv（受信 ) コントロールの各メソッドの仕様について説明します。

Load メソッド▋構文
Function Load( Dlg As Integer// ダイアログの表示) as Long▋解説
ログを読み込みます。

▋引数
パラメータ

Dlg

値

説

明

SFCSLOG_Dialog_FALSE

処理ダイヤログの表示有無を設定します。
ダイアログには、処理状況と中断用の「キャンセル」ボタンが付加。
以下の値を指定できます。
SFCSLOG_Dialog_FALSE (0)SFCSLOG_Dialog_TRUE (1)

表示しない
表示する

▋戻り値
戻り値

説

明

0

正常終了
SFCSLOG_SUCCESS

20

STARFAX Server SDK がインストールされていないか、環境設定で各種フォルダが設定されていません。
SFCSLOG_ERR_Install

21

未送信フォルダが存在しません
SFCSLOG_ERR_NoQueFolder

22

未送信ログの読み込みに失敗しました。
SFCSLOG_ERR_NoGetQue

23

送信ログフォルダが存在しません。
SFCSLOG_ERR_NoSendFolder
28STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
戻り値

説

明

24

送信ログの読み込みに失敗しました。
SFCSLOG_ERR_NoGetSend

25

受信ログフォルダが存在しません
SFCSLOG_ERR_NoRecvFolder

26

受信ログの読み込みに失敗しました。
SFCSLOG_ERR_NoGetRecv▋参照モジュール
SFCSLogDef.bas

Release メソッド▋構文
Sub Release( )▋解説
ログの読み込みを終了します。

▋引数
なし

▋戻り値
なし

▋参照モジュール
SFCSLogDef.bas

Reload メソッド
▋構文
Function Reload( Dlg As Integer// ダイアログの表示) as Long▋解説
ログを読み込みます。

▋引数
パラメータ

Dlg

値

説

明

SFCSLOG_Dialog_FALSE

処理ダイヤログの表示有無を設定します。
ダイアログには、処理状況と中断用の「キャンセル」ボタンが付加。
以下の値を指定できます。
SFCSLOG_Dialog_FALSE (0)SFCSLOG_Dialog_TRUE (1)

29

表示しない
表示する

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
▋戻り値
戻り値

説

明

0

正常終了
SFCSLOG_SUCCESS

20

STARFAX Server SDK がインストールされていないか、環境設定で各種フォルダが設定されていません。
SFCSLOG_ERR_Install

21

未送信フォルダが存在しません
SFCSLOG_ERR_NoQueFolder

22

未送信ログの読み込みに失敗しました。
SFCSLOG_ERR_NoGetQue

23

送信ログフォルダが存在しません。
SFCSLOG_ERR_NoSendFolder

24

送信ログの読み込みに失敗しました。
SFCSLOG_ERR_NoGetSend

25

受信ログフォルダが存在しません
SFCSLOG_ERR_NoRecvFolder

26

受信ログの読み込みに失敗しました。
SFCSLOG_ERR_NoGetRecv▋参照モジュール
SFCSLogDef.bas

GetRecCount メソッド
▋構文
Function GetRecCount( ) as Long

▋解説
ログの件数を取得。

▋引数
なし

▋戻り値
ログ ( 送信、受信、未送信）のレコード数▋参照モジュール
SFCSLogDef.bas

30STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
GetRecItemString メソッド
▋構文
Function GetRecItemString( Rec As Long,
Item As Integer,
Get As String) as Long// レコードの番号// レコードの項目// 文字列 を格納するための変数▋解説
ログのレコードと項目を指定し、文字列を取得します。

▋引数
パラメータ

値

説

明

Rec

”0”

レコード番号を指定します。
レコードの項目を指定します。
SFCSLOG_ITEM_SendName (0)Item

SFCSLOG_ITEM_SendName

SFCSLOG_ITEM_FileName(1)
SFCSLOG_ITEM_FaxNumber (2)送信、未送信ログ：送信先名称
受信ログ：FAX ID
原稿のファイルパス
FAX 番号

SFCSLOG_ITEM_FCodeSFCSLOG_ITEM_Retry

F コード
リトライを行った回数

(3)
(4)

※受信ログにこの項目はありません。

※受信ログにこの項目はありません。

SFCSLOG_ITEM_Date(5)
SFCSLOG_ITEM_Time(6)
SFCSLOG_ITEM_TotalTime (7)SFCSLOG_ITEM_TermSpeed (8)送信日付 (YYYY/MM/DD)
通信開始時刻 (HH:MM:SS)
通信にかかった時間 (HH:MM:SS)
通信速度

SFCSLOG_ITEM_TermReso

(9)

解像度

SFCSLOG_ITEM_TermComp
SFCSLOG_ITEM_TermSize
SFCSLOG_ITEM_TermECM
SFCSLOG_ITEM_Page
SFCSLOG_ITEM_Return
SFCSLOG_ITEM_Line
SFCSLOG_ITEM_Acount
SFCSLOG_ITEM_JobID

(10)
(11)
(12)
(13)
(14)
(15)
(16)
(17)

SFCSLOG_ITEM_Company
SFCSLOG_ITEM_Division
SFCSLOG_ITEM_Position
SFCSLOG_ITEM_Name
SFCSLOG_ITEM_ZipCode
SFCSLOG_ITEM_Address1
SFCSLOG_ITEM_Address2
SFCSLOG_ITEM_Telephone
SFCSLOG_ITEM_Fax
SFCSLOG_ITEM_Title
SFCSLOG_ITEM_FreeArea
SFCSLOG_ITEM_Password
SFCSLOG_ITEM_UserInfo

(18)
(19)
(20)
(21)
(22)
(23)
(24)
(25)
(26)
(27)
(28)
(29)
(30)

FAX 符合化方 (M:MMRR:MRH:MH)
A:A4
B:B4
3:A3
用紙サイズ
D: 利用しない
エラー訂正機能 E: 利用する
FAX 原稿の総ページ数
通信結果のコード (0 →成功 )通信を行った回線番号
アカウント
ジョブ ID"LYYYYMMDDHHMMSSMMM"
送信先情報会社名 *1
送信先情報所属名 *1
送信先情報役職名 *1
送信先情報氏名 *1
送信先情報郵便番号 *1
送信先情報住所 1*1
送信先情報住所 2*1
送信先情報電話番号 *1
送信先情報 FAX 番号 *1
送信先情報敬称 *1
送信先情報ユーザ使用 *1
パスワード
ページヘッダ情報 *1

SFCSLOG_ITEM_UserIDSFCSLOG_ITEM_DelDate
SFCSLOG_ITEM_DelTime
SFCSLOG_ITEMEX_LineDes

(31)
(32)
(33)
(34)

自局電話番号 *1
削除日付 (YYYY/MM/DD)
削除時刻 (HH:MM:SS)
回線指定 *1

SFCSLOG_ITEMEX_Priority(35)

優先順位 *131

2:2400bps
4:4800bps
7:7200bps(V.29)
9:9600bps(V.29) A:7200bps(V.17)
B:9600bps(V.17) C:12000bps E:14400bps
G:16800bps
H:19200bps I: 21600bps
J:24000bps
K:26400bps L:28800bps
M:31200bps
N:33600bps
N: ノーマルF: ファイン

S: スーパーファイン"0": 記録しない "1": 原稿の内側に記録"2": 原稿の外側に記録

N: 指定なし

0: 回線１

1: 回線 2...

N: 指定なし

0 ～ F:0 ～ 15

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
パラメータ

値

説

Get

明

文字列 を格納するための変数*1

受信ログにこの項目はありません。

▋戻り値
戻り値

説

明

0

取得成功
SFCSLOG_SUCCESS

10

メモリエラーが発生しました
SFCSLOG_ERR_Memory

30

未送信ログが読み込まれていません。
SFCSLOG_ERR_NoLoadQue

31

送信ログが読み込まれていません。
SFCSLOG_ERR_NoLoadSend

32

受信ログが読み込まれていません。
SFCSLOG_ERR_NoLoadRecv

33

指定されたレコード番号は範囲外です。
SFCSLOG_ERR_Record

34

指定されて項目番号は文字列で取得できません。
SFCSLOG_ERR_ItemStr▋参照モジュール
SFCSLogDef.bas

GetRecItemInt メソッド
▋構文
Function GetRecItemInt( Rec As Long,
Item As Integer,
Get As String) as Long// レコードの番号// レコードの項目// 文字列 を格納するための変数▋解説
ログのレコードと項目を指定し、文字列を取得します。

▋引数
パラメータ

値

説

Rec

0

レコード番号 (0 ～ )SFCSLOG_ITEM_Return

取得する項目を指定
以下の値を指定できます。
SFCSLOG_ITEM_Retry
SFCSLOG_ITEM_Page
SFCSLOG_ITEM_Return
SFCSLOG_ITEM_Line

Item

Get

明

数値 を格納するための変数

32(4) リトライ回数カウンタ(13) 原稿ページ数(14) 送受信結果番号(15) 回線番号 (0 ～ )STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
▋戻り値
戻り値

説

明

0

取得成功
SFCSLOG_SUCCESS

10

メモリエラーが発生しました。
SFCSLOG_ERR_Memory

30

未送信ログが読み込まれていません。
SFCSLOG_ERR_NoLoadQue

31

送信ログが読み込まれていません。
SFCSLOG_ERR_NoLoadSend

32

受信ログが読み込まれていません。
SFCSLOG_ERR_NoLoadRecv

33

レコード番号の指定が範囲外です。
SFCSLOG_ERR_Record

35

指定されて項目番号は数値で取得できません。SFCSLOG_ERR_ItemInt▋参照モジュール
SFCSLogDef.bas

GetRecComStatus メソッド
▋構文
Function GetRecComStatus( Rec As Long,
GetStatus As Long
) as Long// レコードの番号// 通信状態 を格納するための変数▋解説
未送信ログに登録されている送信情報の状況を取得します。
※送受信ログでは使用できません

▋引数
パラメータ

値

説

明

Rec

0

レコード番号 (0 ～ )通信状態 を格納するための変数
0：送信待ち
1：送信中

GetStatus

▋戻り値
戻り値

説

明

0

取得成功
SFCSLOG_SUCCESS

10

メモリエラーが発生しました。
SFCSLOG_ERR_Memory

30

未送信ログが読み込まれていません。
SFCSLOG_ERR_NoLoadQue

33

レコード番号の指定が範囲外です。
SFCSLOG_ERR_Record
33

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル▋参照モジュール
SFCSLogDef.bas

ResetDelInfo メソッド▋構文
Sub ResetDocInfo( )▋解説
MakeDelMission メソッド実行時の、削除ジョブ ID リストをリセットします。

▋引数
なし

▋戻り値
なし

AddDelInfo メソッド
▋構文
Function AddDelInfo( JobID As String// レコードの番号) as Long▋解説
MakeDelMission メソッド実行時の、削除するレコードのジョブ ID を設定します。

▋引数
パラメータ

値

説

明

JobID

"2013030110001245"

削除するレコードのジョブ ID

▋戻り値
戻り値

説

明

0

追加成功
SFCSLOG_SUCCESS

0 以外

追加失敗

▋参照モジュール
SFCSLogDef.bas

34STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
MakeDelMission メソッド
▋構文
Function MakeDelMission() as Long

▋解説
MakeDelMission メソッド実行時の、削除するレコードのジョブ ID を設定します。

▋引数
なし

▋戻り値
戻り値

説

明

0

正常終了
SFCSLOG_SUCCESS

1

削除命令フォルダが存在しません
SFCSLOG_ERR_NoMisFolder

2

削除命令フォルダの取得に失敗しました
SFCSLOG_ERR_GetMisFolder

3

一時フォルダの取得に失敗しました
SFCSLOG_ERR_GetTempFolder

4

一時ファイルの取得に失敗しました
SFCSLOG_ERR_GetTempFile

5

削除命令ファイル名の作成に失敗しました
SFCSLOG_ERR_MakeMisName

10

メモリエラーが発生しました
SFCSLOG_ERR_Memory▋参照モジュール
SFCSLogDef.bas

35STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

送受信ログの追加、削除状況を知る
STARFAX Server SDK で送受信した最新の情報、削除した情報を取得します。

サンプルプログラム●保存場所※下表の「保存する場所」の＜ OS フォルダ＞部分は、お使いの Windows により異なります。
＜ Windows 8、7、Vista、Server 2012/2012 R2、2008 / 2008 R2 ＞
C:\Users\Public\Documents＜ Windows XP、Server 2003 /2003 R2 ＞
C:\Documents and Settings\All Users\Documents
プログラム\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\MonDiff.exe

開発プロジェクト\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\MonDiff\●サンプルプログラムの仕様
参照

STARFAX Server SDK の送受信、未送信ログを一覧で表示します。
FAX 原稿はダブルクリック、または右クリックメニューの「ビューア」を指定し表示します。

削除

ログの削除は、特定のログを一覧から選択し、右クリックメニューから「削除」を選択します。

●操作方法① STARFAX Server SDK 環境設定で「通知ファイルを作成する」にチェックを入れます。
「ファイル de FAX マニュアル」P14② STARFAX Server SDK のサービスを開始します。
「セットアップマニュアル」P21③ サンプルプログラム「MonDiff.exe」を実行します。
追加済み通知に送信、受信した最新の情報が表示されます。
削除済み通知には、「削除」した対象の情報が表示されます。

SFCSLogDiff コントロール メソッド一覧
メソッド名

詳

細

GetRecvAddNoti

受信情報追加済み通知取得

GetRecvRecItemString

受信情報追加済み通知のレコード項目文字列取得

GetRecvRecItemInt

受信情報追加済み通知のレコード項目数値取得

GetSendAddNoti

送信情報追加済み通知取得

GetSendRecItemString

送信情報追加済み通知のレコード項目文字列取得

GetSendRecItemInt

送信情報追加済み通知のレコード項目数値取得

GetRecvDelNoti

受信情報削除済み通知取得

GetSendDelNoti

送信情報削除済み通知取得

36

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

メソッドの仕様
GetSendAddNoti メソッド（送信）/ GetRecvAddNoti メソッド（受信）▋構文
Function GetSendAddNoti() as Long
Function GetRecvAddNoti() as Long

▋解説
送信、受信ログの追加済通知ファイルを取得します。

▋引数
なし

▋戻り値
戻り値

説

明

0

通知ファイルがありませんでした
SFCSLOGDIFF_GS_NoNoti

1

通知ファイルを読み込みました
SFCSLOGDIFF_GS_Get▋参照モジュール
SFCSLogDiffDef.bas

GetSendRecItemString メソッド ( 送信 ) / GetRecvRecItemString メソッド ( 受信 )▋構文
Function GetSendRecItemString( Item As Integer,
Get As String) as Long// 送信ログの項目の指定

Function GetRecvRecItemString( Item As Integer,
Get As String) as Long// 受信ログの項目の指定// 文字列 を格納するための変数// 文字列 を格納するための変数▋解説
追加済通知ファイルのレコードの項目を文字列で取得します37

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
▋引数
パラメータ

値

説

明

レコードの項目を指定します。
SFCSLOG_ITEM_SendName (0)Item

SFCSLOG_ITEM_SendName

Get

SFCSLOG_ITEM_FileName(1)
SFCSLOG_ITEM_FaxNumber (2)

送信ログ：送信先名称
受信ログ：FAX ID
原稿のファイルパス
FAX 番号

SFCSLOG_ITEM_FCodeSFCSLOG_ITEM_Retry

F コード
リトライを行った回数

(3)
(4)

※受信ログにこの項目はありません。

※受信ログにこの項目はありません。

SFCSLOG_ITEM_Date(5)
SFCSLOG_ITEM_Time(6)
SFCSLOG_ITEM_TotalTime (7)SFCSLOG_ITEM_TermSpeed (8)送信日付 (YYYY/MM/DD)
通信開始時刻 (HH:MM:SS)
通信にかかった時間 (HH:MM:SS)
通信速度

SFCSLOG_ITEM_TermReso

(9)

解像度

SFCSLOG_ITEM_TermComp
SFCSLOG_ITEM_TermSize
SFCSLOG_ITEM_TermECM
SFCSLOG_ITEM_Page
SFCSLOG_ITEM_Return
SFCSLOG_ITEM_Line
SFCSLOG_ITEM_Acount
SFCSLOG_ITEM_JobID

(10)
(11)
(12)
(13)
(14)
(15)
(16)
(17)

SFCSLOG_ITEM_Company
SFCSLOG_ITEM_Division
SFCSLOG_ITEM_Position
SFCSLOG_ITEM_Name
SFCSLOG_ITEM_ZipCode
SFCSLOG_ITEM_Address1
SFCSLOG_ITEM_Address2
SFCSLOG_ITEM_Telephone
SFCSLOG_ITEM_Fax
SFCSLOG_ITEM_Title
SFCSLOG_ITEM_FreeArea
SFCSLOG_ITEM_Password
SFCSLOG_ITEM_UserInfo

(18)
(19)
(20)
(21)
(22)
(23)
(24)
(25)
(26)
(27)
(28)
(29)
(30)

FAX 符合化方 (M:MMRR:MRH:MH)
A:A4
B:B4
3:A3
用紙サイズ
D: 利用しない
エラー訂正機能 E: 利用する
FAX 原稿の総ページ数
通信結果のコード (0 →成功 )通信を行った回線番号
アカウント
ジョブ ID"LYYYYMMDDHHMMSSMMM"
送信先情報会社名 *1
送信先情報所属名 *1
送信先情報役職名 *1
送信先情報氏名 *1
送信先情報郵便番号 *1
送信先情報住所 1*1
送信先情報住所 2*1
送信先情報電話番号 *1
送信先情報 FAX 番号 *1
送信先情報敬称 *1
送信先情報ユーザ使用 *1
パスワード
ページヘッダ情報 *1

SFCSLOG_ITEM_UserIDSFCSLOG_ITEM_DelDate
SFCSLOG_ITEM_DelTime
SFCSLOG_ITEMEX_LineDes

(31)
(32)
(33)
(34)

自局電話番号 *1
削除日付 (YYYY/MM/DD)
削除時刻 (HH:MM:SS)
回線指定 *1

SFCSLOG_ITEMEX_Priority(35)

優先順位 *1

2:2400bps
4:4800bps
7:7200bps(V.29)
9:9600bps(V.29) A:7200bps(V.17)
B:9600bps(V.17) C:12000bps E:14400bps
G:16800bps
H:19200bps I: 21600bps
J:24000bps
K:26400bps L:28800bps
M:31200bps
N:33600bps
N: ノーマルF: ファイン

S: スーパーファイン"0": 記録しない "1": 原稿の内側に記録"2": 原稿の外側に記録

N: 指定なし

0: 回線１

1: 回線 2...

N: 指定なし

0 ～ F:0 ～ 15

文字列 を格納するための変数
*1

▋戻り値
戻り値

説

明

0

取得成功
SFCSLOGDIFF_SUCCESS

10

メモリエラーが発生しました
SFCSLOGDIFF_ERR_Memory30

受信ログが読み込まれていません。
SFCSLOGDIFF_ERR_NoLoadRecv

38

受信ログにこの項目はありません。

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
戻り値

説

明

33

レコード番号の指定が範囲外です。
SFCSLOGDIFF_ERR_Record

34

指定されて項目番号は文字列で取得できません。
SFCSLOGDIFF_ERR_ItemStr▋参照モジュール
SFCSLogDiffDef.bas/

SFCSLogDef.bas

GetSendRecItemInt メソッド（送信）/

GetRecvRecItemInt メソッド（受信）▋構文
Function GetSendRecItemInt(Item As Integer,
Get As Long
) as Long// 送信ログの項目を指定// 数値 を格納するための変数

Function GetRecvRecItemInt( Item As Integer,
Get As Long
) as Long// 受信ログの項目を指定// 数値 を格納するための変数▋解説
追加済み情報ファイル内のレコード項目を数値で取得します。

▋引数
パラメータ

Item

値

説

"2013030110001245"

取得する項目を指定します。
以下の値を指定できます。
SFCSLOG_ITEM_Retry(4) リトライ回数カウンタ
SFCSLOG_ITEM_Page(13) 原稿ページ数
SFCSLOG_ITEM_Return (14) 送受信結果番号
SFCSLOG_ITEM_Line(15) 回線番号 (0 ～ )Get

明

数値 を格納するための変数

▋戻り値
戻り値

説

明

0

取得成功
SFCSLOGDIFF_SUCCESS

10

メモリエラーが発生しました。
SFCSLOGDIFF_ERR_Memory

30

送信ログが読み込まれていません。
SFCSLOGDIFF_ERR_NoLoadSend

33

レコード番号の指定が範囲外です。
SFCSLOGDIFF_ERR_Record

35

指定されて項目番号は数値で取得できません。
SFCSLOGDIFF_ERR_ItemInt▋参照モジュール
SFCSLogDiffDef.bas/

SFCSLogDef.bas
39STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
GetSendDelNoti( 送信 ) / GetRecvDelNoti( 受信 )▋構文
Function GetSendDelNoti( GetJobID As String// 送信ログ削除済みジョブ ID を格納するための変数

Function GetRecvDelNoti( GetJobID As String// 受信 削除済みジョブ ID を格納するための変数) as Long) as Long▋解説
ログの削除済みの通知ファイルを取得します。

▋引数
パラメータ

値

説

GetJobID

明

削除済みジョブ ID を格納するための変数

▋戻り値
戻り値

説

0

通知がありませんでした。
SFCSLOGDIFF_GS_NoNoti

1

通知を読み込みました。
SFCSLOGDIFF_GS_Get

2

明

通知を読み込みました。別の通知ファイルもあります。
SFCSLOGDIFF_GS_GetAndNext※この戻り値が返された場合、再度同じメソッドを実行して他の削除済み通知ファイルを取得してください。
状況によって他の削除済み通知ファイルが削除されます。

▋参照モジュール
SFCSLogDiffDef.bas

40STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

印刷する
STARFAX Server SDK のプリンタドライバを使用して、指定したファイルを印刷します。

サンプルプログラム【PrtFile.exe】●保存場所※下表の「保存する場所」の＜ OS フォルダ＞部分は、お使いの Windows により異なります。
＜ Windows 8、7、Vista、Server 2012/2012 R2、2008 /2008 R2 ＞
C:\Users\Public\Documents＜ Windows XP、Server 2003 /2003 R2 ＞
C:\Documents and Settings\All Users\Documents
プログラム\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\PrtFile.exe

開発プロジェクト\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\PrtFile\●サンプルプログラムの仕様
STARFAX Server SDK のプリンタを事前にセットアップしてください。
「セットアップマニュアル」P11

必須情報

印刷するファイルを指定してください。
ファイル指定最大４件まで指定可能●操作方法① STARFAX Server SDK のサービスを開始します。
「セットアップマニュアル」P21[1]② サンプルプログラム「PrtFile.exe」を実行します。
③ 以下操作します。
[1] ファイル指定
印刷を行うファイルを選択します。
最大 4 件のファイルを指定できます。
[2] 印刷ボタン
選択したファイルの印刷を実行します。

[2]

SFCSPrtFile コントロール メソッド一覧
メソッド名

詳

細

ResetDocInfo

印刷原稿リストリセット

AddDocInfo

印刷原稿リスト追加設定

MakePrintMission

印刷命令ファイル作成

41

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

メソッドの仕様[ SFCSPrtFile ] コントロールの各メソッドの仕様について説明します。

ResetDocInfo メソッド▋構文
Sub ResetDocInfo( )▋解説
MakePrintMission メソッド 実行時の印刷するファイルリストをリセットします。

▋引数
なし

▋戻り値
なし

AddDocInfo メソッド
▋構文
Function AddDocInfo(DocName As String// 印刷するファイルを指定) as Long▋解説
MakePrintMission メソッド 実行時の印刷原稿リストに、印刷原稿を追加設定します。

▋引数
パラメータ

値

説

明

DocName"C:\Genkou\Page01.text"

印刷するファイルのファイルパスを指定します。

▋戻り値
戻り値

説

明

0

追加成功
SFCSPRTFILE_SUCCESS

0 以外

追加失敗
SFCSPRTFILE_SUCCESS 以外▋参照モジュール
SFCSPrtFileDef.bas

42STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
MakePrintMission メソッド
▋構文
Function MakePrintMission() as Long

▋解説
印刷命令ファイルを作成して、指定したファイルを印刷させます。
印刷するファイルは AddDocInfo メソッドで指定します。

▋引数
なし

▋戻り値
戻り値

説

明

0

正常終了
SFCSPRTFILE_SUCCESS

1

印刷命令フォルダが存在しません
SFCSPRTFILE_ERR_NoMisFolder

2

印刷命令フォルダの取得に失敗しました
SFCSPRTFILE_ERR_GetMisFolder

3

一時フォルダの取得に失敗しました
SFCSPRTFILE_ERR_GetTempFolder

4

一時ファイルの取得に失敗しました
SFCSPRTFILE_ERR_GetTempFile

5

印刷命令ファイル名の作成に失敗しました
SFCSPRTFILE_ERR_MakeMisName

100

パラメータエラー : 印刷命令ファイル作成情報が指定されていません。
SFCSPRTFILE_ERR_PARAM_INFO

101

パラメータエラー : 印刷原稿ファイルが指定されていません。
SFCSPRTFILE_ERR_PARAM_DOC

102

パラメータエラー : 印刷原稿ファイル名が指定されていません。
SFCSPRTFILE_ERR_PARAM_DOCNAME▋参照モジュール
SFCSPrtFileDef.bas

43STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル

メールを送信する
STARFAX Server SDK の機能を使用して、メール送信を行います。

サンプルプログラム【SendMail.exe】●保存場所※下表の「保存する場所」の＜ OS フォルダ＞部分は、お使いの Windows により異なります。
＜ Windows 8、7、Vista、Server 2012/2012 R2、2008 /2008 R2 ＞
C:\Users\Public\Documents＜ Windows XP、Server 2003 /2003 R2 ＞
C:\Documents and Settings\All Users\Documents
プログラム\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\SendMail.exe

開発プロジェクト\MEGASOFT\STARFAX Engine\Sample\VB6 SP6\SendMail\●サンプルプログラムの仕様
STARFAX サービスマネージャのメールサーバー設定を事前に行ってください。
「セットアップマニュアル」P20

必須情報「宛先」を指定します。
宛先 / CC

送信するメールの宛先、それ以外に送信する CC のメールアドレスを指定します。

件名 / 本文送信するメールの件名と本文を指定します。4添付ファイル

宛先にメールと一緒に送信するファイルを指定します。
最大 2 件まで登録できます。

●操作方法① STARFAX サービスマネージャのメール設定を行います。
「セットアップマニュアル」P20② STARFAX Server SDK のサービスを開始します。
「セットアップマニュアル」P21③ サンプルプログラム「SendMail.exe」を実行します。
④ 以下操作します。
[1] 宛先※必須
メールの送信先を指定します。

[1]

[2]CC
同内容のメールを宛先以外に送信する際に指定します。

[2]
[3]

[3] 件名送信するメールの件名を指定します。

[4][4] 本文送信するメールの本文を指定します。

[5][5] 添付ファイル
メールに付加して送信するファイルを指定します。
最大 2 つまで指定できます。
⑤ [6] の送信ボタンをクリックします。

[1]~[5] で指定した内容でメール送信を指示します。

[6]

44

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
SFCSSendMail コントロール メソッド一覧
メソッド名

詳

細

ResetToInfo

宛先リストリセット

AddToInfo

宛先リスト追加設定

ResetCcInfo

CC リストリセット

AddCcInfo

CC リスト追加設定

ResetAttachInfo

添付ファイルリストリセット

AddAttachInfo

添付ファイルリスト追加設定

MakeEMailMission

メール送信命令ファイル作成

メソッドの仕様[ SFCSSendMail] コントロールの各メソッドの仕様について説明します。

ResetToInfo メソッド▋構文
Sub ResetToInfo( )▋解説
MakeEMailMission メソッド実行時の宛先をリセットします。

▋引数
なし

▋戻り値
なし

AddToInfo メソッド
▋構文
Function AddToInfo( ToAddress As String// 送信先の宛先 ( メールアドレス ) を指定) as Long▋解説
MakeEMailMission メソッド実行時の宛先を指定します。

▋引数
パラメータ

値

説

明

ToAddress"sousin@megasoft.co.jp"

送信する宛先を指定します。
宛先を複数指定する場合は、「,」を間に入れます。

45

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
▋戻り値
戻り値

説

明

0

追加成功
SFCSSENDMAIL_SUCCESS

0 以外

追加失敗
SFCSSENDMAIL_SUCCESS 以外▋参照モジュール
SFCSSendMailDef.bas

ResetCcInfo メソッド▋構文
Sub ResetCcInfo()▋解説
MakeEMailMission メソッド実行時の CC をリセットします。

▋引数
なし

▋戻り値
なし

AddCcInfo メソッド
▋構文
Function AddCcInfo( CcAddress As String// 送信するメールの CC を指定) as Long▋解説
MakeEMailMission メソッド実行時の CC を指定します。

▋引数
パラメータ

値

説

明

CcAddress"sousin2@megasoft.co.jp"

送信するメールの CC を指定します。
宛先を複数指定する場合は、「,」を間に入れます。

▋戻り値
戻り値

説

明

0

追加成功
SFCSSENDMAIL_SUCCESS

0 以外

追加失敗
SFCSSENDMAIL_SUCCESS 以外
46

STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル▋参照モジュール
SFCSSendMailDef.bas

ResetAttachInfo メソッド▋構文
Sub ResetAttachInfo( )▋解説
MakeEMailMission メソッド実行時の添付ファイルをリセットします。

▋引数
なし

▋戻り値
なし

AddAttachInfo メソッド
▋構文
Function AddAttachInfo( AttachName As String // 添付するファイルを指定) as Long▋解説
MakePrintMission メソッド 実行時の印刷原稿リストに、印刷原稿を追加設定します。

▋引数
パラメータ

値

説

明

AttachName"C:\Genkou\Page01.text"

添付するファイルのファイルパスを指定します。

▋戻り値
戻り値

説

明

0

追加成功
SFCSSENDMAIL_SUCCESS

0 以外

追加失敗
SFCSSENDMAIL_SUCCESS 以外▋参照モジュール
SFCSSendMailDef.bas

47STARFAX Server SDK ＞ VB 開発向け OCX リファレンスマニュアル
MakeEMailMission メソッド
▋構文
Function MakeEMailMission(Subject As String,
TheBody As String) as Long// メールの件名を指定// メールの本文を指定▋解説
メール送信命令ファイルを作成します。
実行時の各種動作設定は、以下のメソッドで行ってください。
ResetToInfo メソッド
AddToInfo メソッド
ResetCcInfo メソッド
AddCcInfo メソッド
ResetAttachInfo メソッド AddAttachInfo メソッド

▋引数
パラメータ

値

説

明

Subject" 業務連絡 "件名に表示する内容を指定します。

TheBody" 本日の日報を添付します "本文に表示する内容を指定します。

▋戻り値
戻り値

説

明

0

正常終了
SFCSSENDFAX_SUCCESS

1

メール送信命令フォルダが存在しません。
SFCSSENDMAIL_ERR_NoMisFolder

2

メール送信命令フォルダの取得に失敗しました。
SFCSSENDMAIL_ERR_GetMisFolder

3

一時フォルダの取得に失敗しました。
SFCSSENDMAIL_ERR_GetTempFolder

4

一時ファイルの取得に失敗しました。
SFCSSENDMAIL_ERR_GetTempFile

5

メール送信命令ファイル名の作成に失敗しました。
SFCSSENDMAIL_ERR_MakeMisName

100

パラメータエラー メール送信命令ファイル作成情報が指定されていません。
SFCSSENDMAIL_ERR_PARAM_INFO

101

パラメータエラー 宛先が指定されていません。
SFCSSENDMAIL_ERR_PARAM_TO

103

パラメータエラー 宛先アドレスが指定されていません。
SFCSSENDMAIL_ERR_PARAM_TOADR

104

パラメータエラー CC アドレスが指定されていません。
SFCSSENDMAIL_ERR_PARAM_CCADR

105

パラメータエラー 添付ファイルパスが指定されていません。
SFCSSENDMAIL_ERR_PARAM_ATTACHNAME▋参照モジュール
SFCSSendMailDef.bas

48