DsmlRequestDocument Class
TOC
Collapse the table of content
Expand the table of content

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.

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

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

public class DsmlRequestDocument : DsmlDocument, IList, ICollection, 
	IEnumerable

NameDescription
System_CAPS_pubmethodDsmlRequestDocument()

The DsmlRequestDocument constructor creates an instance of the DsmlRequestDocument class.

NameDescription
System_CAPS_pubpropertyCount

The Count property contains the number of DirectoryRequest objects in this collection.

System_CAPS_pubpropertyDocumentProcessing

The DocumentProcessing property contains one of the values of DsmlDocumentProcessing that specifies how the elements of the collection are processed.

System_CAPS_pubpropertyErrorProcessing

The ErrorProcessing property contains one of the values of DsmlErrorProcessing that specifies how errors are processed.

System_CAPS_protpropertyIsFixedSize

The IsFixedSize property contains a value that indicates whether the DsmlRequestDocument has a fixed size.

System_CAPS_protpropertyIsReadOnly

The IsReadOnly property contains a value indicating whether the DsmlRequestDocument is read only or not.

System_CAPS_protpropertyIsSynchronized

The IsSynchronized property contains a value that indicates whether access to the DsmlRequestDocument is synchronized (thread-safe).

System_CAPS_pubpropertyItem[Int32]

The Item property contains the DirectoryRequest object at the specified index.

System_CAPS_pubpropertyRequestId

The RequestId property contains the RequestID associated with the DsmlRequestDocument.

System_CAPS_pubpropertyResponseOrder

The ResponseOrder property contains one of the values of DsmlResponseOrder that specifies the order of the response.

System_CAPS_protpropertySyncRoot

The SyncRoot property contains an object that can be used to synchronize access to the DsmlRequestDocument.

NameDescription
System_CAPS_pubmethodAdd(DirectoryRequest)

The Add method adds a DirectoryRequest object to the collection.

System_CAPS_pubmethodClear()

The Clear method removes all items from this collection.

System_CAPS_pubmethodContains(DirectoryRequest)

The Contains method determines whether this DsmlRequestDocument collection contains the specified DirectoryRequest object.

System_CAPS_pubmethodCopyTo(DirectoryRequest[], Int32)

The CopyTo method copies the entire DsmlRequestDocument collection to a one-dimensional array, starting at the specified index of the target array.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

The GetEnumerator method returns an enumerator for the entire DsmlRequestDocument collection.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(DirectoryRequest)

The IndexOf method returns the zero-based index of the first occurrence of the specified DirectoryRequest object in the DsmlRequestDocument collection.

System_CAPS_pubmethodInsert(Int32, DirectoryRequest)

The Insert method inserts the specified DirectoryRequest object into the DsmlRequestDocument collection at the specified index.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemove(DirectoryRequest)

The Remove method removes the first occurrence of the specified DirectoryRequest object from the collection.

System_CAPS_pubmethodRemoveAt(Int32)

The RemoveAt method removes the DirectoryRequest object at the specified position.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodToXml()

The ToXml method transforms each DirectoryRequest object in the collection into an XmlDocument object.(Overrides DsmlDocument.ToXml().)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

The M:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.ICollection.CopyTo(System.Array,System.Int32) method copies the entire DsmlRequestDocument collection to a one-dimensional array, starting at the specified index of the target array.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)
System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Clear()
System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

The M:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.IList.Contains(System.Object) method determines whether this DsmlRequestDocument collection contains the specified DirectoryRequest object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

The M:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.IList.IndexOf(System.Object) method returns the zero-based index of the first occurrence of the specified DirectoryRequest object in the DsmlRequestDocument collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

The M:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.IList.Insert(System.Int32,System.Object) method inserts the specified DirectoryRequest object into the DsmlRequestDocument collection at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

The M:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.IList.Remove(System.Object) method removes the first occurrence of the specified DirectoryRequest object from the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.RemoveAt(Int32)
System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.Count
System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

The P:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.ICollection.IsSynchronized property gets a value that indicates whether access to the DsmlRequestDocument is synchronized (thread-safe).

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

The P:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.ICollection.SyncRoot property gets an object that can be used to synchronize access to the DsmlRequestDocument.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

The P:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.IList.IsFixedSize property gets a value that indicates whether the DsmlRequestDocument has a fixed size.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsReadOnly

The P:System.DirectoryServices.Protocols.DsmlRequestDocument.System.Collections.IList.IsReadOnly property gets a value that indicates whether the DsmlRequestDocument is read-only or not.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item[Int32]

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft