ServiceDebugBehavior.HttpHelpPageEnabled Properti

Definisi

Ruang nama:

System.ServiceModel.Description

Rakitan:

System.ServiceModel.dll

Mendapatkan atau menetapkan nilai yang mengontrol apakah Windows Communication Foundation (WCF) menerbitkan halaman bantuan HTML di alamat yang dikontrol oleh HttpHelpPageUrl properti .

public:
 property bool HttpHelpPageEnabled { bool get(); void set(bool value); };

public bool HttpHelpPageEnabled { get; set; }

member this.HttpHelpPageEnabled : bool with get, set

Public Property HttpHelpPageEnabled As Boolean

Nilai Properti

Boolean

true jika WCF menerbitkan halaman bantuan HTML; jika tidak, false. Defaultnya adalah true.

Contoh

Contoh kode berikut menunjukkan cara menggunakan file konfigurasi untuk mengaktifkan fitur halaman bantuan HTML dan mengembalikan informasi pengecualian di dalam kesalahan SOAP kembali ke klien untuk tujuan penelusuran kesalahan. File konfigurasi ini memperlihatkan langkah-langkah dasar berikut untuk menambahkan dukungan untuk fitur:ServiceDebugBehavior

• Karena jenisnya ServiceDebugBehavior adalah System.ServiceModel.Description.IServiceBehavior implementasi, <elemen layanan> yang mewakili jenis layanan memiliki pengidentifikasi behaviorConfiguration="metadataAndDebug"konfigurasi perilaku .

• Sekali lagi, karena ServiceDebugBehavior jenisnya adalah System.ServiceModel.Description.IServiceBehavior implementasi <, elemen perilaku> ditambahkan ke <bagian serviceBehaviors> . Atribut name<elemen perilaku> yang nilainya adalah pengidentifikasi behaviorConfiguration atribut <elemen layanan> . Dalam hal ini, nilainya metadataAndDebug.

• <Tambahkan elemen serviceDebug> dengan berbagai atribut yang diatur ke konfigurasi yang diinginkan. Dalam hal ini, httpHelpPageEnabled nilai atribut dan includeExceptionDetailInFaults diatur ke true.

<configuration>
  <system.serviceModel>
    <services>
      <!-- 
        Step 1. Add a behaviorConfiguration attribute
        in the <service> element.
      -->
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataAndDebug">
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/SampleService" />
          </baseAddresses>
        </host>
        <endpoint
          address=""
          binding="wsHttpBinding"
          contract="Microsoft.WCF.Documentation.ISampleService"
        />
        <endpoint
           address="mex"
           binding="mexHttpBinding"
           contract="IMetadataExchange"
        />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <!-- 
          Step 2. Inside a <serviceBehaviors> section, add 
          a name attribute in the <behaviors> element that 
          matches the behaviorConfiguration attribute in the
          <service> element above.
        -->
        <behavior name="metadataAndDebug">
          <serviceMetadata 
            httpGetEnabled="true" 
            httpGetUrl=""
          />
          <!-- 
            Step 3. Add a <serviceDebug> element and 
            modify the various attributes that suit your 
            scenario.
          -->
          <serviceDebug 
            httpHelpPageEnabled="true" 
            includeExceptionDetailInFaults="true"
          />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Keterangan

Atur HttpHelpPageEnabled properti ke false untuk menonaktifkan publikasi halaman bantuan HTML yang terlihat oleh browser HTML.

Untuk memastikan halaman bantuan HTML diterbitkan di lokasi yang dikontrol oleh HttpsHelpPageUrl properti, Anda harus mengatur properti ini ke true lalu salah satu kondisi berikut juga harus benar:

• Properti HttpsHelpPageUrl adalah alamat absolut yang mendukung skema protokol HTTP.

• Ada alamat dasar untuk layanan yang mendukung skema protokol HTTP.

Meskipun pengecualian dilemparkan jika alamat absolut yang tidak mendukung skema protokol HTTP ditetapkan ke HttpsHelpPageUrl properti, skenario lain di mana tidak satu pun dari kriteria sebelumnya terpenuhi tidak menghasilkan pengecualian dan tidak ada halaman bantuan HTML.