Export (0) Print
Expand All

DsmlRequestDocument Class

The DsmlRequestDocument class enables you to build a DSML request payload, such as AddRequest, ModifyRequest, or SearchRequest. It contains zero or more DirectoryRequest derived objects. The user may add, delete, modify, and enumerate the DirectoryRequest before sending to the server. DsmlRequestDocument can be used with any DSML Binding classes to transport the document, such as DsmlSoapHttpConnection.

System.Object
  System.DirectoryServices.Protocols.DsmlDocument
    System.DirectoryServices.Protocols.DsmlRequestDocument

Namespace:  System.DirectoryServices.Protocols
Assembly:  System.DirectoryServices.Protocols (in System.DirectoryServices.Protocols.dll)

public class DsmlRequestDocument : DsmlDocument, 
	IList, ICollection, IEnumerable

The DsmlRequestDocument type exposes the following members.

  NameDescription
Public methodDsmlRequestDocumentThe DsmlRequestDocument constructor creates an instance of the DsmlRequestDocument class.
Top

  NameDescription
Public propertyCountThe Count property contains the number of DirectoryRequest objects in this collection.
Public propertyDocumentProcessingThe DocumentProcessing property contains one of the values of DsmlDocumentProcessing that specifies how the elements of the collection are processed.
Public propertyErrorProcessingThe ErrorProcessing property contains one of the values of DsmlErrorProcessing that specifies how errors are processed.
Protected propertyIsFixedSizeThe IsFixedSize property contains a value that indicates whether the DsmlRequestDocument has a fixed size.
Protected propertyIsReadOnlyThe IsReadOnly property contains a value indicating whether the DsmlRequestDocument is read only or not.
Protected propertyIsSynchronizedThe IsSynchronized property contains a value that indicates whether access to the DsmlRequestDocument is synchronized (thread-safe).
Public propertyItemThe Item property contains the DirectoryRequest object at the specified index.
Public propertyRequestIdThe RequestId property contains the RequestID associated with the DsmlRequestDocument.
Public propertyResponseOrderThe ResponseOrder property contains one of the values of DsmlResponseOrder that specifies the order of the response.
Protected propertySyncRootThe SyncRoot property contains an object that can be used to synchronize access to the DsmlRequestDocument.
Top

  NameDescription
Public methodAddThe Add method adds a DirectoryRequest object to the collection.
Public methodClearThe Clear method removes all items from this collection.
Public methodContainsThe Contains method determines whether this DsmlRequestDocument collection contains the specified DirectoryRequest object.
Public methodCopyToThe CopyTo method copies the entire DsmlRequestDocument collection to a one-dimensional array, starting at the specified index of the target array.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorThe GetEnumerator method returns an enumerator for the entire DsmlRequestDocument collection.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfThe IndexOf method returns the zero-based index of the first occurrence of the specified DirectoryRequest object in the DsmlRequestDocument collection.
Public methodInsertThe Insert method inserts the specified DirectoryRequest object into the DsmlRequestDocument collection at the specified index.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveThe Remove method removes the first occurrence of the specified DirectoryRequest object from the collection.
Public methodRemoveAtThe RemoveAt method removes the DirectoryRequest object at the specified position.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodToXmlThe ToXml method transforms each DirectoryRequest object in the collection into an XmlDocument object. (Overrides DsmlDocument.ToXml().)
Top

  NameDescription
Public Extension MethodAsParallel()Overloaded. Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsParallel()Overloaded. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryable()Overloaded. Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodAsQueryable()Overloaded. (Defined by Queryable.)
Public Extension MethodCast<TResult>()Overloaded. Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodCast<TResult>()Overloaded. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>()Overloaded. Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>()Overloaded. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToThe CopyTo method copies the entire DsmlRequestDocument collection to a one-dimensional array, starting at the specified index of the target array.
Explicit interface implemetationPrivate propertyICollection.CountThe Count property gets the number of DirectoryRequest objects in this collection.
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedThe IsSynchronized property gets a value that indicates whether access to the DsmlRequestDocument is synchronized (thread-safe).
Explicit interface implemetationPrivate propertyICollection.SyncRootThe SyncRoot property gets an object that can be used to synchronize access to the DsmlRequestDocument.
Explicit interface implemetationPrivate methodIList.AddThe Add method adds a DirectoryRequest object to the collection.
Explicit interface implemetationPrivate methodIList.ClearThe Clear method removes all items from the collection.
Explicit interface implemetationPrivate methodIList.ContainsThe Contains method determines whether this DsmlRequestDocument collection contains the specified DirectoryRequest object.
Explicit interface implemetationPrivate methodIList.IndexOfThe IndexOf method returns the zero-based index of the first occurrence of the specified DirectoryRequest object in the DsmlRequestDocument collection.
Explicit interface implemetationPrivate methodIList.InsertThe Insert method inserts the specified DirectoryRequest object into the DsmlRequestDocument collection at the specified index.
Explicit interface implemetationPrivate propertyIList.IsFixedSizeThe IsFixedSize property gets a value that indicates whether the DsmlRequestDocument has a fixed size.
Explicit interface implemetationPrivate propertyIList.IsReadOnlyThe IsReadOnly property gets a value that indicates whether the DsmlRequestDocument is read-only or not.
Explicit interface implemetationPrivate propertyIList.ItemThe Item property gets or sets the DirectoryRequest object at the specified index.
Explicit interface implemetationPrivate methodIList.RemoveThe Remove method removes the first occurrence of the specified DirectoryRequest object from the collection.
Explicit interface implemetationPrivate methodIList.RemoveAtThe RemoveAt method removes the DirectoryRequest object at the specified position.
Top

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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