System.DirectoryServices Namespace

 

The System.DirectoryServices namespace provides easy access to Active Directory Domain Services from managed code. The namespace contains two component classes, DirectoryEntry and DirectorySearcher, which use the Active Directory Services Interfaces (ADSI) technology. ADSI is the set of interfaces that Microsoft provides as a flexible tool for working with a variety of network providers. ADSI gives the administrator the ability to locate and manage resources on a network with relative ease, regardless of the size of the network.

ClassDescription
System_CAPS_pubclassActiveDirectoryAccessRule

The ActiveDirectoryAccessRule class is used to represent an access control entry (ACE) in the discretionary access control list (DACL) of an Active Directory Domain Services object.

System_CAPS_pubclassActiveDirectoryAuditRule

The ActiveDirectoryAuditRule is used to set an access control entry (ACE) on a system access control list (SACL). The ActiveDirectoryAccessRule contains the trustee, which is represented as an IdentityReference object. It also contains information about the access control type, access mask, and other properties such as inheritance flags. This rule is set on an ActiveDirectorySecurity object. After the ActiveDirectorySecurity is committed to the directory store, it will modify the security descriptor object according to the rules that are set on ActiveDirectoryAuditRule.

System_CAPS_pubclassActiveDirectorySecurity

Uses the object security layer of the managed ACL library to wrap access control functionality for directory objects.

System_CAPS_pubclassCreateChildAccessRule

The CreateChildAccessRule class represents a specific type of access rule that is used to allow or deny an Active Directory Domain Services object the right to create child objects.

System_CAPS_pubclassDeleteChildAccessRule

The DeleteChildAccessRule class represents a specific type of access rule that is used to allow or deny an Active Directory Domain Services object the right to delete child objects.

System_CAPS_pubclassDeleteTreeAccessRule

The DeleteTreeAccessRule class represents a specific type of access rule that is used to allow or deny an Active Directory Domain Services object the right to delete all child objects, regardless of the permissions that the child objects have.

System_CAPS_pubclassDirectoryEntries

Contains a collection of DirectoryEntry objects.

System_CAPS_pubclassDirectoryEntry

The DirectoryEntry class encapsulates a node or object in the Active Directory Domain Services hierarchy.

System_CAPS_pubclassDirectoryEntryConfiguration

The DirectoryEntryConfiguration class provides a direct way to specify and obtain provider-specific options for manipulating a directory object. Typically, the options apply to search operations of the underlying directory store. The supported options are provider-specific.

System_CAPS_pubclassDirectorySearcher

Performs queries against Active Directory Domain Services.

System_CAPS_pubclassDirectoryServicesCOMException

Contains extended error information about an error that occurred when the Invoke method is called.

System_CAPS_pubclassDirectoryServicesPermission

The DirectoryServicesPermission class allows you to control code access security permissions for System.DirectoryServices.

System_CAPS_pubclassDirectoryServicesPermissionAttribute

Allows declarative System.DirectoryServices permission checks.

System_CAPS_pubclassDirectoryServicesPermissionEntry

The DirectoryServicesPermissionEntry class defines the smallest unit of a code access security permission set for System.DirectoryServices.

System_CAPS_pubclassDirectoryServicesPermissionEntryCollection

Contains a strongly-typed collection of DirectoryServicesPermissionEntry objects.

System_CAPS_pubclassDirectorySynchronization

Specifies how to synchronize a directory within a domain.

System_CAPS_pubclassDirectoryVirtualListView

The DirectoryVirtualListView class specifies how to conduct a virtual list view search. A virtual list view search enables users to view search results as address-book style virtual list views. It is specifically designed for very large result sets. Search data is retrieved in contiguous subsets of a sorted directory search.

System_CAPS_pubclassDirectoryVirtualListViewContext

Specifies how to construct directory virtual list view response.

System_CAPS_pubclassDSDescriptionAttribute

Supports the .NET Framework infrastructure and is not intended to be used directly from code.

System_CAPS_pubclassExtendedRightAccessRule

Represents a specific type of access rule that is used to allow or deny an Active Directory object an extended right. Extended rights are special operations that are not covered by the standard set of access rights. An example of an extended right is Send-As, which gives a user the right to send e-mail for another user. For a list of possible extended rights, see the topic Extended Rights in the MSDN Library at http://msdn.microsoft.com/library. For more information about extended rights, see the topic Control Access Rights, also in the MSDN Library.

System_CAPS_pubclassListChildrenAccessRule

The ListChildrenAccessRule class represents a specific type of access rule that is used to allow or deny an Active Directory Domain Services object the right to list child objects.

System_CAPS_pubclassPropertyAccessRule

The PropertyAccessRule class represents a specific type of access rule that is used to allow or deny access to an Active Directory Domain Services property.

System_CAPS_pubclassPropertyCollection

The PropertyCollection class contains the properties of a DirectoryEntry.

System_CAPS_pubclassPropertySetAccessRule

The PropertySetAccessRule class represents a specific type of access rule that is used to allow or deny access to an Active Directory Domain Services property set. For a list of property sets that are defined for Active Directory Domain Services, see the topic Property Sets in the MSDN Library at http://msdn.microsoft.com/library.

System_CAPS_pubclassPropertyValueCollection

Contains the values of a DirectoryEntry property.

System_CAPS_pubclassResultPropertyCollection

Contains the properties of a SearchResult instance.

System_CAPS_pubclassResultPropertyValueCollection

Contains the values of a SearchResult property.

System_CAPS_pubclassSchemaNameCollection

Contains a list of the schema names that the SchemaFilter property of a DirectoryEntries object can use.

System_CAPS_pubclassSearchResult

The SearchResult class encapsulates a node in the Active Directory Domain Services hierarchy that is returned during a search through DirectorySearcher.

System_CAPS_pubclassSearchResultCollection

The SearchResultCollection class contains the SearchResult instances that the Active Directory hierarchy returned during a DirectorySearcher query.

System_CAPS_pubclassSortOption

Specifies how to sort the results of a search.

EnumerationDescription
System_CAPS_pubenumActiveDirectoryRights

The ActiveDirectoryRights enumeration specifies the access rights that are assigned to an Active Directory Domain Services object.

System_CAPS_pubenumActiveDirectorySecurityInheritance

The ActiveDirectorySecurityInheritance enumeration specifies if, and how, ACE information is applied to an object and its descendents.

System_CAPS_pubenumAuthenticationTypes

The AuthenticationTypes enumeration specifies the types of authentication used in System.DirectoryServices. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

System_CAPS_pubenumDereferenceAlias

The DereferenceAlias enumeration specifies how aliases are resolved. This enumeration provides values for the DirectorySearcher.DerefAlias property.

System_CAPS_pubenumDirectoryServicesPermissionAccess

The DirectoryServicesPermissionAccess enumeration defines access levels that are used by System.DirectoryServices permission classes. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

System_CAPS_pubenumDirectorySynchronizationOptions

Contains flags that determine how directories within a domain will be synchronized. These options can be set for the DirectorySynchronization.Option property.

System_CAPS_pubenumExtendedDN

The ExtendedDN enumeration specifies the format in which to return the extended distinguished name. This enumeration is used with the DirectorySearcher.ExtendedDN property.

System_CAPS_pubenumPasswordEncodingMethod

Specifies whether SSL is used when you set or change a password. This enumeration is used with the DirectoryEntryConfiguration.PasswordEncoding property.

System_CAPS_pubenumPropertyAccess

The PropertyAccess enumeration is used with the PropertyAccessRule and PropertySetAccessRule classes to indicate the type of access that is applied to an Active Directory property or property set.

System_CAPS_pubenumReferralChasingOption

The ReferralChasingOption enumeration specifies if and how referral chasing is pursued.

System_CAPS_pubenumSearchScope

Specifies the possible scopes for a directory search that is performed using the DirectorySearcher object.

System_CAPS_pubenumSecurityMasks

Specifies the available options for examining security information of a directory object. This enumeration is used with the DirectorySearcher.SecurityMasks and DirectoryEntryConfiguration.SecurityMasks properties.

System_CAPS_pubenumSortDirection

The SortDirection enumeration specifies how to sort the results of an Active Directory Domain Services query.

The classes in this namespace can be used with any of the Active Directory Domain Services service providers. The current providers are: Internet Information Services (IIS), Lightweight Directory Access Protocol (LDAP), Novell NetWare Directory Service (NDS), and WinNT.

ADSI is a programmatic interface for Microsoft Active Directory Domain Services that enables your applications to interact with diverse directories on a network using a single interface. Using ADSI, you can create applications that perform common tasks, such as backing up databases, accessing printers, and administering user accounts.

It is assumed that you have a general understanding of Active Directory Domain Services before using these classes. For more information on Active Directory Domain Services, see the topics Introduction to Active Directory Objects and Active Directory Technology Backgrounder, as well as the following topics in the MSDN library at http://msdn.microsoft.com/library:

Active Directory Domain Services use a tree structure. Each node in the tree contains a set of properties. Use this namespace to traverse, search, and modify the tree, and read and write to the properties of a node.

The DirectoryEntry class encapsulates a node or object in the Active Directory Domain Services hierarchy. Use this class for binding to objects, reading properties, and updating attributes. Together with helper classes, DirectoryEntry provides support for life-cycle management and navigation methods, including creating, deleting, renaming, moving a child node, and enumerating children.

Use the DirectorySearcher class to perform queries against the Active Directory Domain Services hierarchy. LDAP is the only system-supplied Active Directory Service Interfaces (ADSI) provider that supports searching.

A search of the Active Directory Domain Services hierarchy through DirectorySearcher returns instances of SearchResult, which are contained in an instance of the SearchResultCollection class.

Note: Many of the classes, methods, and properties in the System.DirectoryServices namespace use the LinkDemand code access security option. This means that the code access security demand only occurs during just-in-time compilation and that the demand is performed only on the calling assembly and not up the entire call stack. Because of this, callers should not pass objects that are created from this namespace at runtime to code that is not trusted.

Return to top
Show: