DsmlRequestDocument Class

Definition

Namespace:

System.DirectoryServices.Protocols

Assembly:

System.DirectoryServices.Protocols.dll

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.

public ref class DsmlRequestDocument : System::DirectoryServices::Protocols::DsmlDocument, System::Collections::IList

public class DsmlRequestDocument : System.DirectoryServices.Protocols.DsmlDocument, System.Collections.IList

type DsmlRequestDocument = class
    inherit DsmlDocument
    interface IList
    interface ICollection
    interface IEnumerable

Public Class DsmlRequestDocument
Inherits DsmlDocument
Implements IList

Inheritance

Object

DsmlDocument

DsmlRequestDocument

Implements

ICollection IEnumerable IList

Constructors

DsmlRequestDocument()

The DsmlRequestDocument() constructor creates an instance of the DsmlRequestDocument class.

Properties

Count	The Count property contains the number of DirectoryRequest objects in this collection.
DocumentProcessing	The DocumentProcessing property contains one of the values of DsmlDocumentProcessing that specifies how the elements of the collection are processed.
ErrorProcessing	The ErrorProcessing property contains one of the values of DsmlErrorProcessing that specifies how errors are processed.
IsFixedSize	The IsFixedSize property contains a value that indicates whether the DsmlRequestDocument has a fixed size.
IsReadOnly	The IsReadOnly property contains a value indicating whether the DsmlRequestDocument is read only or not.
IsSynchronized	The IsSynchronized property contains a value that indicates whether access to the DsmlRequestDocument is synchronized (thread-safe).
Item[Int32]	The Item[Int32] property contains the DirectoryRequest object at the specified index.
RequestId	The RequestId property contains the RequestID associated with the DsmlRequestDocument.
ResponseOrder	The ResponseOrder property contains one of the values of DsmlResponseOrder that specifies the order of the response.
SyncRoot	The SyncRoot property contains an object that can be used to synchronize access to the DsmlRequestDocument.

Methods

Add(DirectoryRequest)	The Add(DirectoryRequest) method adds a DirectoryRequest object to the collection.
Clear()	The Clear() method removes all items from this collection.
Contains(DirectoryRequest)	The Contains(DirectoryRequest) method determines whether this DsmlRequestDocument collection contains the specified DirectoryRequest object.
CopyTo(DirectoryRequest[], Int32)	The CopyTo(DirectoryRequest[], Int32) method copies the entire DsmlRequestDocument collection to a one-dimensional array, starting at the specified index of the target array.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	The GetEnumerator() method returns an enumerator for the entire DsmlRequestDocument collection.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(DirectoryRequest)	The IndexOf(DirectoryRequest) method returns the zero-based index of the first occurrence of the specified DirectoryRequest object in the DsmlRequestDocument collection.
Insert(Int32, DirectoryRequest)	The Insert(Int32, DirectoryRequest) method inserts the specified DirectoryRequest object into the DsmlRequestDocument collection at the specified index.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Remove(DirectoryRequest)	The Remove(DirectoryRequest) method removes the first occurrence of the specified DirectoryRequest object from the collection.
RemoveAt(Int32)	The RemoveAt(Int32) method removes the DirectoryRequest object at the specified position.
ToString()	Returns a string that represents the current object. (Inherited from Object)
ToXml()	The ToXml() method transforms each DirectoryRequest object in the collection into an XmlDocument object.

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	Copies the entire DsmlRequestDocument collection to a one-dimensional array, starting at the specified index of the target array.
ICollection.Count	Gets the number of DirectoryRequest objects in this collection.
ICollection.IsSynchronized	Gets a value that indicates whether access to the DsmlRequestDocument is synchronized (thread-safe).
ICollection.SyncRoot	Gets an object that can be used to synchronize access to the DsmlRequestDocument.
IList.Add(Object)	Adds a DirectoryRequest object to the collection.
IList.Clear()	Removes all items from the collection.
IList.Contains(Object)	Indicates whether this DsmlRequestDocument collection contains the specified DirectoryRequest object.
IList.IndexOf(Object)	Returns the zero-based index of the first occurrence of the specified DirectoryRequest object in the DsmlRequestDocument collection.
IList.Insert(Int32, Object)	Inserts the specified DirectoryRequest object into the DsmlRequestDocument collection at the specified index.
IList.IsFixedSize	Gets a value that indicates whether the DsmlRequestDocument has a fixed size.
IList.IsReadOnly	Gets a value that indicates whether the DsmlRequestDocument is read-only or not.
IList.Item[Int32]	Gets or sets the DirectoryRequest object at the specified index.
IList.Remove(Object)	Removes the first occurrence of the specified DirectoryRequest object from the collection.
IList.RemoveAt(Int32)	Removes the DirectoryRequest object at the specified position.

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

See also

• ICollection
• IList