ActiveDirectorySite.FindByName Method

Returns a site based on a site name.

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

'Declaration
Public Shared Function FindByName ( _
	context As DirectoryContext, _
	siteName As String _
) As ActiveDirectorySite

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.

ExceptionCondition
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 Nothing.

AuthenticationException

The credentials that were supplied are not valid.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft