ActiveDirectorySite.FindByName Method (DirectoryContext, String)

 

Returns a site based on a site name.

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

public static ActiveDirectorySite FindByName(
	DirectoryContext context,
	string siteName
)

Parameters

context
Type: System.DirectoryServices.ActiveDirectory.DirectoryContext

An DirectoryContext object that is valid for this site.

siteName
Type: System.String

The name of the site to find.

Return Value

Type: System.DirectoryServices.ActiveDirectory.ActiveDirectorySite

An ActiveDirectorySite object for the requested site.

Exception Condition
ActiveDirectoryObjectNotFoundException

The site could not be found for the given siteName in the context specified.

ActiveDirectoryOperationException

A call to the underlying directory service resulted in an error.

ActiveDirectoryServerDownException

The target server is either busy or unavailable.

ArgumentException

This exception will occur for any one of the following reasons:

  • The target in the context parameter is not a forest, configuration set, domain controller, or an AD LDS server.

  • siteName is an empty string.

ArgumentNullException

context or siteName is null.

AuthenticationException

The credentials that were supplied are not valid.

.NET Framework
Available since 2.0
Return to top
Show: