DiscoveryClientProtocol.ReadAll Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Reads in a file containing a map of saved discovery documents populating the Documents and References properties, with discovery documents, XML Schema Definition (XSD) schemas, and service descriptions referenced in the file.

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

[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
public DiscoveryClientResultCollection ReadAll(
	string topLevelFilename
)

Parameters

topLevelFilename
Type: System.String

Name of file to read in, containing the map of saved discovery documents.

Return Value

Type: System.Web.Services.Discovery.DiscoveryClientResultCollection

A DiscoveryClientResultCollection containing the results found in the file with the map of saved discovery documents. The file format is a DiscoveryClientProtocol.DiscoveryClientResultsFile class serialized into XML; however, one would typically create the file using only the WriteAll method or Disco.exe.

A file containing a map of saved discovery documents can be created by the WriteAll method or Disco.exe.

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 populates a DataGrid with the details about the documents and references found in an existing discovery map document using the ReadAll method.

  protected void Discover_Click(object Source, EventArgs e)
  {
// Specify the URL to read the discovery results from.
string outputDirectory = DiscoDir.Text;

       DiscoveryClientProtocol client = new DiscoveryClientProtocol();
// Use default credentials to access the files containing the discovery results.
       client.Credentials = CredentialCache.DefaultCredentials;

       try {
      	  DiscoveryDocument doc;
  // Read in existing discovery results.
         DiscoveryClientResultCollection results = client.ReadAll(Path.Combine(DiscoDir.Text,"results.discomap"));
       }
       catch ( Exception e2) 
       {
         DiscoveryResultsGrid.Columns.Clear();
         Status.Text = e2.Message;
       }
// If discovery documents existed in the supplied folder, display the results in a data grid.
       if (client.Documents.Count > 0)
    PopulateGrid(client);
 }

.NET Framework
Available since 1.1
Return to top
Show: