Export (0) Print
Expand All

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.

For a list of all members of this type, see DiscoveryClientDocumentCollection Members.

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

[Visual Basic]
NotInheritable Public Class DiscoveryClientDocumentCollection
   Inherits DictionaryBase
[C#]
public sealed class DiscoveryClientDocumentCollection :
   DictionaryBase
[C++]
public __gc __sealed class DiscoveryClientDocumentCollection :
   public DictionaryBase
[JScript]
public class DiscoveryClientDocumentCollection extends
   DictionaryBase

Thread Safety

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

Remarks

The Documents property of DiscoveryClientProtocol is of type DiscoveryClientDocumentCollection.

Example

[Visual Basic, C#, C++] 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.

[Visual Basic] 
Imports System
Imports System.Net
Imports System.IO
Imports System.Collections
Imports System.Web.Services.Discovery

Public Class DiscoveryClientDocumentCollectionSample
   
   Public Shared Sub Main()
      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 'Main
End Class 'DiscoveryClientDocumentCollectionSample

[C#] 
using System;
using System.Net;
using System.IO;
using System.Collections;
using System.Web.Services.Discovery;

public class DiscoveryClientDocumentCollectionSample
{
   public static void Main()
   {
      DiscoveryClientProtocol myDiscoveryClientProtocol =
         new DiscoveryClientProtocol();
      
      myDiscoveryClientProtocol.Credentials = CredentialCache.DefaultCredentials;

      // 'dataservice.disco' is a sample discovery document.
      string myStringUrl = "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("The discovery documents in the collection are :");
      for (int iIndex=0; iIndex < myObjectCollection.Length; iIndex++)
      {
         Console.WriteLine(myObjectCollection[iIndex]);
      }
      
      Console.WriteLine("");

      // 'Values' in the collection are retrieved.
      ICollection myCollection1 = myDiscoveryClientDocumentCollection.Values;
      object[] myObjectCollection1 = 
         new object[myDiscoveryClientDocumentCollection.Count];
      myCollection1.CopyTo(myObjectCollection1, 0);
      
      Console.WriteLine("The objects in the collection are :");
      for (int iIndex=0; iIndex < myObjectCollection1.Length; iIndex++)
      {
         Console.WriteLine(myObjectCollection1[iIndex]);
      }
   }
} 

[C++] 
#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]);
   }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Web.Services.Discovery

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

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

See Also

DiscoveryClientDocumentCollection Members | System.Web.Services.Discovery Namespace | IDictionary | DictionaryBase

Show:
© 2014 Microsoft