DiscoveryClientProtocol.WriteAll Method (String, String)

 

Writes all discovery documents, XML Schema Definition (XSD) schemas, and Service Descriptions in the Documents property to the supplied directory and creates a file in that directory.

Namespace:   System.Web.Services.Discovery
Assembly:  System.Web.Services (in System.Web.Services.dll)

<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")>
Public Function WriteAll (
	directory As String,
	topLevelFilename As String
) As DiscoveryClientResultCollection

Parameters

directory
Type: System.String

The directory in which to save all documents currently in the Documents property.

topLevelFilename
Type: System.String

The name of the file to create or overwrite containing a map of all documents saved.

Return Value

Type: System.Web.Services.Discovery.DiscoveryClientResultCollection

A DiscoveryClientResultCollection containing the results of all files saved.

The file created with the name of the topLevelFilename parameter in the directory specified by the directory parameter contains a map of saved discovery documents, XML Schema Definition (XSD) schemas and service descriptions. This file can be read in using the ReadAll method to populate the References and Documents properties. The format of the file is XML containing an serialized version of the DiscoveryClientProtocol.DiscoveryClientResultsFile class.

If a file exists with the same name as the topLevelFilename parameter in the directory parameter, that file is overwritten by the WriteAll method. The topLevelFilename parameter must include the fully qualified path if the file does not exist in the current directory.

The following code example is a Web Form that writes the results of a Web Services discovery to disk by invoking the WriteAll method after calls to DiscoverAny and ResolveAll.

  Public Sub Discover_Click(Source As Object, e as EventArgs )
     ' Specify the URL to discover.
     Dim sourceUrl as String = DiscoURL.Text
     ' Specify the URL to save discovery results to or read from.
     Dim outputDirectory As String = DiscoDir.Text

     Dim client as DiscoveryClientProtocol = new DiscoveryClientProtocol()
     ' Use default credentials to access the URL being discovered.
     client.Credentials = CredentialCache.DefaultCredentials
     Try 
      	Dim doc As DiscoveryDocument
       ' Discover the URL for any discoverable documents. 
       doc = client.DiscoverAny(sourceUrl)

' Resolve all possible references from the supplied URL.
       client.ResolveAll()

      Catch e2 As Exception
      	  DiscoveryResultsGrid.Columns.Clear()
         Status.Text = e2.Message
      End Try

      ' Save the discovery results to disk.	    
      Dim results As DiscoveryClientResultCollection 
      results = client.WriteAll(outputDirectory, "results.discomap")
      Status.Text = "The following file holds the links to each of the discovery results: <b>" + _ 
                                 Path.Combine(outputDirectory,"results.discomap") + "</b>"
     End Sub

.NET Framework
Available since 1.1
Return to top
Show: