if2cstub(クライアントスタブ生成コマンド(.NETインタフェース定義用))
形式
if2cstub {-t {svr|clt|con} 〔-l {cs|vb}〕 〔-s 生成ファイル拡張子〕 〔-n 名前空間名称〕 〔-o 出力先ディレクトリ〕 〔-r スタブクラス名称〕 〔-c {struct|nostruct}〕 〔-X {normal|dataset}〕 〔-m RPCメッセージの最大長〕 -i .NETインタフェース定義ファイル名称 インタフェース名称 |-h}
機能
C#,またはVisual Basicで定義された .NETインタフェース定義を基に,クライアントスタブクラスのソースファイル(以降,クライアントスタブソースファイルと呼びます)を生成します。
オプション
●-t {svr|clt|con}
生成するクライアントスタブの種類を指定します。
オプションの指定と生成されるクライアントスタブを次に示します。
オプションの指定 |
生成されるクライアントスタブ |
---|---|
svr |
SPP.NETまたはSUP.NET(Extension .NET)用 |
clt |
CUP.NET(Client .NET)用 |
con |
CUP.NET(Connector .NET)用 |
●-l {cs|vb}
生成するクライアントスタブソースファイルのプログラム言語を指定します。
このオプションを省略した場合,入力元のソースファイルと同じプログラム言語で生成します。入力元のソースファイルのプログラム言語は,ファイルの拡張子を基に判断されます。
オプションの指定と生成されるクライアントスタブソースファイルのプログラム言語の関係を次に示します。
オプションの指定 |
生成されるクライアントスタブソースファイルのプログラム言語 |
---|---|
cs |
C# |
vb |
Visual Basic |
このオプションを省略した場合に生成されるクライアントスタブソースファイルのプログラム言語を次に示します。
入力元のソースファイルの拡張子 |
生成されるクライアントスタブソースファイルのプログラム言語 |
---|---|
cs |
C# |
vb |
Visual Basic |
●-s 生成ファイル拡張子 〜〈文字列〉
生成するクライアントスタブソースファイルの拡張子を指定します。
このオプションを省略した場合,生成されるクライアントスタブソースファイルのプログラム言語によって,拡張子は次のようになります。
生成されるクライアントスタブソースファイルのプログラム言語 |
生成されるクライアントスタブソースファイルの拡張子 |
---|---|
C# |
cs |
Visual Basic |
vb |
●-n 名前空間名称 〜〈文字列〉
生成するクライアントスタブクラスの名前空間名称を指定します。
このオプションを省略した場合,入力元のインタフェースが属する名前空間と同じ名前空間でクライアントスタブクラスが生成されます。入力元のインタフェースが名前空間なしの場合,名前空間なしのクライアントスタブクラスが生成されます。
●-o 出力先ディレクトリ 〜〈パス名〉
生成するクライアントスタブソースファイルを出力するディレクトリを指定します。絶対パスまたは相対パスで指定してください。
このオプションを省略した場合,コマンド実行時のディレクトリに出力されます。なお,ファイル名はクライアントスタブごとに「〈名前空間を含まないスタブクラス名称〉.〈拡張子〉」で生成されます。
●-r スタブクラス名称 〜〈文字列〉
生成するクライアントスタブのクラス名称を指定します。
このオプションを省略した場合,クラス名称は「〈インタフェース名称〉Stub」になります。
●-c {struct|nostruct} 〜《struct》
.NETインタフェース定義のメソッドのパラメタまたは戻り値にTP1ユーザ構造体を使用した場合に,クライアントスタブが利用するためのTP1ユーザ構造体クラスを出力するかどうかを指定します。
このオプションを省略した場合,TP1ユーザ構造体クラスを出力します。.NETインタフェース定義にTP1ユーザ構造体を指定していなかった場合,このオプションの指定は無視されます。
struct:TP1ユーザ構造体クラスを出力します。
nostruct:TP1ユーザ構造体クラスを出力しません。
●-X {normal|dataset}
生成されるクライアントスタブに,引数および戻り値がXmlDocumentクラス(System.Xml.XmlDocument)となるサービスメソッドが追加されます。
また,サービスメソッドに入力パラメタがある場合,入力データ用XMLスキーマファイルがサービスメソッドごとに出力されます。出力パラメタまたは戻り値がある場合,出力データ用XMLスキーマファイルがサービスメソッドごとに出力されます。
-tオプションにconを指定した場合だけ,このオプションの指定が有効になります。-tオプションにcon以外を指定した場合,このオプションの指定は無視されます。
このオプションを省略した場合,生成されるクライアントスタブに,引数および戻り値がXmlDocumentクラスとなるサービスメソッドは追加されません。また,入力データ用XMLスキーマファイルおよび出力データ用XMLスキーマファイルは出力されません。
normal:引数および戻り値のXmlDocumentオブジェクト(System.Xml.XmlDocument)を,.NET FrameworkのDataSetオブジェクト(System.Data.DataSet)と連携させない場合に指定します。normalを指定した場合,出力される入力データ用XMLスキーマファイルおよび出力データ用XMLスキーマファイルは,DataSetオブジェクトで利用できない場合があります。
dataset:引数および戻り値のXmlDocumentオブジェクト(System.Xml.XmlDocument)を,.NET FrameworkのDataSetオブジェクト(System.Data.DataSet)と連携させて利用する場合に指定します。datasetを指定した場合,DataSetオブジェクトで利用できる入力データ用XMLスキーマファイルおよび出力データ用XMLスキーマファイルを出力します。また,その入力データ用XMLスキーマおよび出力データ用XMLスキーマに対応したクライアントスタブを出力します。
●-m RPCメッセージの最大長 〜〈符号なし整数〉((1〜8))《1》(単位:メガバイト)
サービスメソッドが指定するRPCメッセージの最大長を指定します。
このオプションに1〜8以外を指定した場合は,エラーが発生します。なお,このオプションは,-tオプションにsvrを指定したときだけ有効です。-tオプションの指定がsvr以外の場合は,-mオプションの指定は無視されます。
●-i .NETインタフェース定義ファイル名称 〜〈ファイル名〉
入力元のインタフェースが定義されている.NETインタフェース定義ファイル名称を指定します。絶対パスまたは相対パスで指定してください。
.NETインタフェース定義を作成したプログラム言語は,このオプションで指定したファイルの拡張子によって次のように判断されます。
このオプションで指定した.NETインタフェース定義ファイルの拡張子 |
.NETインタフェース定義を作成したプログラム言語の判断結果 |
---|---|
cs |
C# |
vb |
Visual Basic |
●-h
このコマンドの使用方法を標準出力に表示します。
このオプションを指定した場合,ほかのオプションおよびコマンド引数は指定できません。
コマンド引数
●インタフェース名称
生成したいクライアントスタブに対応するSPP.NETのインタフェース名称を完全限定名で指定します。インタフェース名称は一つだけ指定できます。
注意事項
-
このコマンドの実行時にエラーが発生した場合は,対応するエラーメッセージが標準エラー出力に出力されます。
-
このコマンドで生成したクライアントスタブソースファイルの内容は変更しないでください。
-
入力元となる.NETインタフェース定義ファイルは,使用するWindowsのデフォルトコードページ(日本語版Windowsの場合は932)で保存してください。Unicodeなど,ほかのコードページで保存したファイルは,このコマンドの入力元として使用できません。