if2tsp(TSP生成コマンド(.NETインタフェース定義用))
形式
if2tsp {〔-l {cs|vb}〕 〔-s 生成ファイル拡張子〕 〔-n 名前空間名称〕 〔-o 出力先ディレクトリ〕 〔-r クラス名称〕 〔-c {struct|nostruct}〕 〔-t soap〕 〔-S {doc|rpc}〕 〔-x {literal|encoded}〕 〔-w XML Web サービスで使用するXML名前空間名称〕 〔-N SOAPメッセージに関連づけられる名前空間名称〕 〔-B {wsibp11|none}〕 〔-A {true|false}〕 〔-p Connector .NETが利用する構成定義のプロファイルID〕 -i .NETインタフェース定義ファイル名称 -g サービスグループ名 インタフェース名称 |-h}
機能
C#,またはVisual Basicで定義された.NETインタフェース定義を基に,TSP実装クラス,XML Webサービスクラス,asmxファイル,クライアントスタブ,および構成ファイルを生成します。
オプション
●-l {cs|vb}
生成するTSP実装クラス,XML Webサービスクラス,およびクライアントスタブクラスのソースファイルのプログラム言語を指定します。
このオプションを省略した場合,入力元のソースファイルと同じプログラム言語で生成します。入力元のソースファイルのプログラム言語は,ファイルの拡張子を基に判断されます。
オプションの指定と,生成されるTSP実装クラス,XML Webサービスクラス,およびクライアントスタブクラスのソースファイルのプログラム言語を次に示します。
オプションの指定 |
生成されるソースファイルのプログラム言語 |
---|---|
cs |
C# |
vb |
Visual Basic |
このオプションを省略した場合に生成されるTSP実装クラス,XML Webサービスクラス,およびクライアントスタブクラスのソースファイルのプログラム言語を次に示します。
入力元ソースファイルの拡張子 |
生成されるソースファイルのプログラム言語 |
---|---|
cs |
C# |
vb |
Visual Basic |
●-s 生成ファイル拡張子 〜〈文字列〉
生成するTSP実装クラス,XML Webサービスクラス,およびクライアントスタブの拡張子を指定します。
このオプションを省略した場合,生成されるTSP実装クラス,XML Webサービスクラス,およびクライアントスタブクラスのソースファイルのプログラム言語によって,拡張子は次のようになります。
生成されるソースファイルのプログラム言語 |
生成されるソースファイルの拡張子 |
---|---|
C# |
cs |
Visual Basic |
vb |
●-n 名前空間名称 〜〈文字列〉
生成するTSP実装クラス,XML Webサービスクラス,およびクライアントスタブクラスの名前空間名称を指定します。
このオプションを省略した場合,入力元のインタフェースが属する名前空間と同じ名前空間でTSP実装クラス,XML Webサービスクラス,およびクライアントスタブが生成されます。入力元のインタフェースが名前空間なしの場合,名前空間なしのTSP実装クラス,XML Webサービスクラス,およびクライアントスタブが生成されます。
●-o 出力先ディレクトリ 〜〈パス名〉
生成するTSP実装クラス,XML Webサービスクラス,クライアントスタブ,asmxファイル,および構成ファイルを出力するディレクトリを指定します。絶対パスまたは相対パスで指定してください。
このオプションを省略した場合,コマンド実行時のディレクトリに出力されます。
●-r クラス名称 〜〈文字列〉
生成するTSP実装クラス,XML Webサービスクラス,およびクライアントスタブクラスのクラス名称,ならびに構成ファイルのファイル名称を指定します。
このオプションを指定した場合と省略した場合のクラス名称およびファイル名称は次のとおりです。
クラスおよびファイル |
生成されるクラス名称およびファイル名称 |
|
---|---|---|
オプションを指定した場合 |
オプションを省略した場合 |
|
TSP実装クラス |
〈クラス名称〉Proxy |
〈インタフェース名称〉Proxy |
XML Webサービスクラス |
〈クラス名称〉WebService |
〈インタフェース名称〉WebService |
クライアントスタブクラス |
〈クラス名称〉Stub |
〈インタフェース名称〉Stub |
構成ファイル |
〈TSP実装クラス名称〉.config |
〈インタフェース名称〉Proxy.config |
なお,上記の表の〈クラス名称〉部分だけが,-rオプションで指定するクラス名称です。
●-c {struct|nostruct} 〜《struct》
.NETインタフェース定義のメソッドのパラメタまたは戻り値にTP1ユーザ構造体を使用した場合に,クライアントスタブが利用するためのTP1ユーザ構造体クラスを出力するかどうかを指定します。
このオプションを省略した場合,TP1ユーザ構造体クラスを出力します。.NETインタフェース定義にTP1ユーザ構造体を指定していなかった場合,このオプションの指定は無視されます。
struct:TP1ユーザ構造体クラスを出力します。
nostruct:TP1ユーザ構造体クラスを出力しません。
●-t soap
XML Webサービスクラスを生成します。
このオプションを省略した場合,XML Webサービスクラスは生成されません。
●-S {doc|rpc} 〜《doc》
XML Webサービスメソッドとの間で送受信されるSOAPメッセージの書式を指定します。このオプションは,-tオプションを指定した場合にだけ有効です。指定しなかった場合,-Sオプションの指定は無視されます。
このオプションを省略した場合,docが仮定されます。
オプションの指定と送受信されるSOAPメッセージの書式を次に示します。
オプションの指定 |
送受信されるSOAPメッセージの書式 |
---|---|
doc |
XML Webサービスメソッドとの間で送受信されるSOAPメッセージの書式は,Documentになります。 |
rpc |
XML Webサービスメソッドとの間で送受信されるSOAPメッセージの書式は,RPCになります。 |
●-x {literal|encoded} 〜《literal》
XML Webサービスメソッドとの間で送受信されるSOAPパラメタの書式指定スタイルを指定します。このオプションは,-tオプションを指定した場合かつSOAPメッセージの書式がDocumentの場合にだけ有効です。-tオプションを指定しなかった場合,-xオプションの指定は無視されます。
-Sオプションにrpcを指定した場合,-xオプションの指定は無視され,encodedが仮定されます。
このオプションを省略した場合,literalが仮定されます。
オプションの指定と送受信されるSOAPパラメタの書式指定スタイルを次に示します。
オプションの指定 |
送受信されるSOAPパラメタの書式指定スタイル |
---|---|
literal |
XML Webサービスメソッドとの間で送受信されるSOAPパラメタの書式指定スタイルは,Literalになります。 |
encoded |
XML Webサービスメソッドとの間で送受信されるSOAPパラメタの書式指定スタイルは,Encodedになります。 |
●-w XML Web サービスで使用するXML名前空間名称 〜〈文字列〉
XML Webサービスで使用するXML名前空間名称を指定します。このオプションは,-tオプションを指定した場合にだけ有効です。指定しなかった場合,-wオプションの指定は無視されます。
このオプションを省略した場合の名前空間名称は,.NET Frameworkのデフォルト値になります。.NET Frameworkのデフォルト値については,.NET Frameworkのドキュメントを参照してください。
●-N SOAPメッセージに関連づけられる名前空間名称 〜〈文字列〉
XML Web サービスメソッドに対するSOAP要求,およびSOAP応答に関連づける名前空間を指定します。このオプションは,-tオプションを指定した場合にだけ有効です。指定しなかった場合,-Nオプションの指定は無視されます。また,メソッドごとに名前空間名称を指定することはできません。
このオプションを省略した場合の名前空間名称は,.NET Frameworkのデフォルト値になります。.NET Frameworkのデフォルト値については,.NET Frameworkのドキュメントを参照してください。
●-B {wsibp11|none}
XML Webサービスクラスが,WS-I Basic Profile 1.1に準拠するかどうかを宣言します。このオプションは-tオプションを指定し,かつ-Sオプションにdocを指定した場合だけ有効です。これらのオプションを指定しなかった場合は,-Bオプションの指定は無視されます。
wsibp11:XML Webサービスクラスが,WS-I Basic Profile 1.1に準拠していることを宣言します。XML Webサービスクラスに,WebServiceBinding.ConformsToプロパティの値としてWsiProfiles.BasicProfile1_1が付加されます。
none:XML Webサービスクラスが,WS-I Basic Profile 1.1に準拠していることを宣言しません。XML Webサービスクラスに,WebServiceBinding.ConformsToプロパティの値としてWsiProfiles.Noneが付加されます。
●-A {true|false}
XML WebサービスクラスのWebサービス記述言語(WSDL)ファイルで,WS-I Basic Profile準拠の表示をするかどうかを指定します。このオプションは-Bオプションを指定した場合だけ有効です。このオプションを省略した場合,WSDLファイルでWS-I Basic Profile準拠に関する表示はされません。
true:WSDLファイルで,-Bオプションで指定したWS-I Basic Profile準拠の表示をします。XML Webサービスクラスに,WebServiceBinding.EmitConformanceClaimsプロパティの値としてtrueが付加されます。
false:WSDLファイルで,-Bオプションで指定したWS-I Basic Profile準拠の表示をしません。XML Webサービスクラスに,WebServiceBinding.EmitConformanceClaimsプロパティの値としてfalseが付加されます。
●-p Connector .NETが利用する構成定義のプロファイルID 〜〈文字列〉
Connector .NETが利用する構成定義のプロファイルIDを指定します。
このオプションを省略した場合,デフォルトプロファイルの情報を利用してConnector .NETを使用します。
●-i .NETインタフェース定義ファイル名称 〜〈ファイル名〉
入力元のインタフェースが定義されている.NETインタフェース定義ファイルを指定します。絶対パスまたは相対パスで指定してください。
.NETインタフェース定義を作成したプログラム言語は,このオプションで指定したファイルの拡張子によって次のように判断されます。
このオプションで指定した.NETインタフェース定義ファイルの拡張子 |
.NETインタフェース定義を作成したプログラム言語の判断結果 |
---|---|
cs |
C# |
vb |
Visual Basic |
●-g サービスグループ名 〜〈31文字以内の識別子〉
呼び出したいSPP.NETのサービスグループ名を指定します。
このオプションの指定値をXML Webサービス生成後に変更したい場合は,サービスグループ名を構成ファイル(Web.configまたはmachine.config)に指定します。詳細については,「2.6.3 TSPの動作設定」を参照してください。
●-h
このコマンドの使用方法を標準出力に表示します。
このオプションを指定した場合,ほかのオプションおよびコマンド引数は指定できません。
コマンド引数
●インタフェース名称
生成したいTSPに対応するSPP.NETのインタフェース名称を完全限定名で指定します。インタフェース名称は一つだけ指定できます。
注意事項
-
このコマンドの実行時にエラーが発生した場合は,対応するエラーメッセージが標準エラー出力に出力されます。
-
このコマンドで生成したTSPソースファイルの内容を変更しないでください。
-
入力元となる.NETインタフェース定義ファイルは,使用するWindowsのデフォルトコードページ(日本語版Windowsの場合は932)で保存してください。Unicodeなど,ほかのコードページで保存したファイルは,このコマンドの入力元として使用できません。