This documentation is archived and is not being maintained.

DiscoveryClientDocumentCollection Class

Represents a collection of documents discovered during XML Web services discovery that have been downloaded to the client. This class cannot be inherited.

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

'Declaration
Public NotInheritable Class DiscoveryClientDocumentCollection _
	Inherits DictionaryBase
'Usage
Dim instance As DiscoveryClientDocumentCollection

The Documents property of DiscoveryClientProtocol is of type DiscoveryClientDocumentCollection.

The following code example enacts XML Web service discovery and downloads the discovered documents to the client. The names of the discovery documents within the DiscoveryClientDocumentCollection are output to the console.

Imports System
Imports System.Net
Imports System.IO
Imports System.Collections
Imports System.Security.Permissions
Imports System.Web.Services.Discovery

Class DiscoveryClientDocumentCollectionSample

   Shared Sub Main()
      Run()
   End Sub 'Main

   <PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
   Shared Sub Run()

      Dim myDiscoveryClientProtocol As New DiscoveryClientProtocol()

      myDiscoveryClientProtocol.Credentials = CredentialCache.DefaultCredentials

      ' 'dataservice.disco' is a sample discovery document. 
      Dim myStringUrl As String = "http://localhost/dataservice.disco" 

      ' 'Discover' method is called to populate the 'Documents' property. 
      Dim myDiscoveryDocument As DiscoveryDocument = myDiscoveryClientProtocol.Discover(myStringUrl)

      ' An instance of the 'DiscoveryClientDocumentCollection' class is created. 
      Dim myDiscoveryClientDocumentCollection As DiscoveryClientDocumentCollection = _
                                                myDiscoveryClientProtocol.Documents

      ' 'Keys' in the collection are retrieved. 
      Dim myCollection As ICollection = myDiscoveryClientDocumentCollection.Keys
      Dim myObjectCollection(myDiscoveryClientDocumentCollection.Count-1) As Object
      myCollection.CopyTo(myObjectCollection, 0)

      Console.WriteLine("The discovery documents in the collection are :")
      Dim iIndex As Integer 
      For iIndex = 0 To myObjectCollection.Length - 1
         Console.WriteLine(myObjectCollection(iIndex))
      Next iIndex

      Console.WriteLine("")

      ' 'Values' in the collection are retrieved. 
      Dim myCollection1 As ICollection = myDiscoveryClientDocumentCollection.Values
      Dim myObjectCollection1(myDiscoveryClientDocumentCollection.Count-1) As Object
      myCollection1.CopyTo(myObjectCollection1, 0)

      Console.WriteLine("The objects in the collection are :")
      For iIndex = 0 To myObjectCollection1.Length - 1
         Console.WriteLine(myObjectCollection1(iIndex))
      Next iIndex
   End Sub 'Run
End Class 'DiscoveryClientDocumentCollectionSample
#using <mscorlib.dll>
#using <System.dll>
#using <System.Web.Services.dll>
using namespace System;
using namespace System::Net;
using namespace System::IO;
using namespace System::Collections;
using namespace System::Web::Services::Discovery;

int main() {
   DiscoveryClientProtocol* myDiscoveryClientProtocol = new DiscoveryClientProtocol();

   myDiscoveryClientProtocol->Credentials = CredentialCache::DefaultCredentials;

   // 'dataservice.disco' is a sample discovery document.
   String* myStringUrl = S"http://localhost/dataservice.disco";

   // 'Discover' method is called to populate the 'Documents' property.
   DiscoveryDocument * myDiscoveryDocument = 
      myDiscoveryClientProtocol->Discover(myStringUrl);

   // An instance of the 'DiscoveryClientDocumentCollection' class is created.
   DiscoveryClientDocumentCollection * myDiscoveryClientDocumentCollection = 
      myDiscoveryClientProtocol->Documents;

   // 'Keys' in the collection are retrieved.
   ICollection* myCollection = myDiscoveryClientDocumentCollection->Keys;
   Object* myObjectCollection[] = new Object*[myDiscoveryClientDocumentCollection->Count];
   myCollection->CopyTo(myObjectCollection, 0);

   Console::WriteLine(S"The discovery documents in the collection are :");
   for (int iIndex=0; iIndex < myObjectCollection->Length; iIndex++)
   {
      Console::WriteLine(myObjectCollection->Item[iIndex]);
   }

   Console::WriteLine(S"");

   // 'Values' in the collection are retrieved.
   ICollection* myCollection1 = myDiscoveryClientDocumentCollection->Values;
   Object* myObjectCollection1[] = new Object*[myDiscoveryClientDocumentCollection->Count];
   myCollection1->CopyTo(myObjectCollection1, 0);

   Console::WriteLine(S"The objects in the collection are :");
   for (int iIndex=0; iIndex < myObjectCollection1->Length; iIndex++)
   {
      Console::WriteLine(myObjectCollection1->Item[iIndex]);
   }
}

System.Object
  System.Collections.DictionaryBase
    System.Web.Services.Discovery.DiscoveryClientDocumentCollection

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: