ServiceDescriptionImporter.AddServiceDescription メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ServiceDescriptionImporter.AddServiceDescription メソッド

指定した ServiceDescription を、インポートされる ServiceDescriptions 値のコレクションに追加します。

名前空間: System.Web.Services.Description
アセンブリ: System.Web.Services (system.web.services.dll 内)
構文

Visual Basic (宣言)

Public Sub AddServiceDescription ( _
    serviceDescription As ServiceDescription, _
    appSettingUrlKey As String, _
    appSettingBaseUrl As String _
)

Visual Basic (使用法)

Dim instance As ServiceDescriptionImporter
Dim serviceDescription As ServiceDescription
Dim appSettingUrlKey As String
Dim appSettingBaseUrl As String

instance.AddServiceDescription(serviceDescription, appSettingUrlKey, appSettingBaseUrl)

public void AddServiceDescription (
    ServiceDescription serviceDescription,
    string appSettingUrlKey,
    string appSettingBaseUrl
)

C++

public:
void AddServiceDescription (
    ServiceDescription^ serviceDescription, 
    String^ appSettingUrlKey, 
    String^ appSettingBaseUrl
)

public void AddServiceDescription (
    ServiceDescription serviceDescription, 
    String appSettingUrlKey, 
    String appSettingBaseUrl
)

JScript

public function AddServiceDescription (
    serviceDescription : ServiceDescription, 
    appSettingUrlKey : String, 
    appSettingBaseUrl : String
)

パラメータ

serviceDescription: コレクションに追加する ServiceDescription インスタンス。

appSettingUrlKey: serviceDescription パラメータで表されるインスタンスから生成されるプロキシクラスの、Url プロパティの初期値を設定します。web.config ファイルの <appsetting> セクションから生成するように指定します。

appSettingBaseUrl: serviceDescription パラメータで表されるインスタンスから生成されるプロキシクラスの、Url プロパティの初期値を設定します。このプロパティの初期値の生成は、このパラメータの値と WSDL ドキュメントの location 属性で指定された URL の組み合わせから行うように指定します。

解説

このメソッドを使用して、ServiceDescription インスタンスを、Import メソッドが呼び出されたときにインポートされるコレクションに追加します。

appSettingUrlKey および appSettingBaseUrl の 2 つの文字列パラメータは、インポートされた ServiceDescription 値から生成される XML Web サービスプロキシの Url プロパティを生成する方法を指定します。appSettingUrlKey パラメータは、構成キーとしてパラメータ値を使用する方法で web.config ファイルの <appsettings> セクションから Url プロパティを読み取ることを指定します。appSettingUrlKey パラメータが null 参照 (Visual Basic では Nothing) または空の文字列の場合、初期値は WSDL (Web Services Description Language) ドキュメント内の location 属性によって決定されます。Style の値が Server の場合は、appSettingUrlKey パラメータの値を設定しようとするとエラーが発生します。

appSettingBaseUrl パラメータは、Url プロパティの初期値の生成を、このパラメータ値と WSDL ドキュメントの location 属性で指定された URL との組み合わせによって行うように指定します。appSettingUrlKey パラメータも指定する必要があります。Url プロパティは、相対 URL と web.config ファイルから読み込まれた URL との組み合わせによって構築されます (相対 URL は appSettingBaseUrl パラメータと、WSDL で指定された URL から生成されます)。このパラメータが null 参照 (Visual Basic では Nothing) または空の文字列である場合、URL はすべて web.config ファイルの値から生成されます。

使用例

ServiceDescriptionImporter クラスを使用するときの AddServiceDescription メソッドの使用例を次に示します。

// Initialize a service description importer.
ServiceDescriptionImporter importer = new ServiceDescriptionImporter();
importer.ProtocolName = "Soap12";  // Use SOAP 1.2.
importer.AddServiceDescription(description,null,null);

C++

// Initialize a service description importer.
ServiceDescriptionImporter^ importer = gcnew ServiceDescriptionImporter;
importer->ProtocolName = "Soap12"; // Use SOAP 1.2.
importer->AddServiceDescription( description, nullptr, nullptr );