ActiveDirectorySiteLink.FindByName Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns a site link based on a site link name.
Overloads
FindByName(DirectoryContext, String, ActiveDirectoryTransportType) |
Returns a site link based on a site link name and transport. |
FindByName(DirectoryContext, String) |
Returns a site link based on a site link name. |
FindByName(DirectoryContext, String, ActiveDirectoryTransportType)
- Source:
- ActiveDirectorySiteLink.cs
- Source:
- ActiveDirectorySiteLink.cs
Returns a site link based on a site link name and transport.
public:
static System::DirectoryServices::ActiveDirectory::ActiveDirectorySiteLink ^ FindByName(System::DirectoryServices::ActiveDirectory::DirectoryContext ^ context, System::String ^ siteLinkName, System::DirectoryServices::ActiveDirectory::ActiveDirectoryTransportType transport);
public static System.DirectoryServices.ActiveDirectory.ActiveDirectorySiteLink FindByName (System.DirectoryServices.ActiveDirectory.DirectoryContext context, string siteLinkName, System.DirectoryServices.ActiveDirectory.ActiveDirectoryTransportType transport);
static member FindByName : System.DirectoryServices.ActiveDirectory.DirectoryContext * string * System.DirectoryServices.ActiveDirectory.ActiveDirectoryTransportType -> System.DirectoryServices.ActiveDirectory.ActiveDirectorySiteLink
Public Shared Function FindByName (context As DirectoryContext, siteLinkName As String, transport As ActiveDirectoryTransportType) As ActiveDirectorySiteLink
Parameters
- context
- DirectoryContext
An DirectoryContext object that is valid for this site link.
- siteLinkName
- String
The name of the site link to find.
- transport
- ActiveDirectoryTransportType
An ActiveDirectoryTransportType object that specifies the transport type.
Returns
An ActiveDirectorySiteLink object for the requested site link.
Exceptions
The site could not be found for the given siteLinkName
in the context
specified.
A call to the underlying directory service resulted in an error.
The target server is either busy or unavailable.
The target in the context
parameter is not a forest, configuration set, domain controller, or an AD LDS server.
-or-
siteLinkName
is an empty string.
context
or siteLinkName
is null
.
The transport
parameter is not a valid ActiveDirectoryTransportType value.
The transport
type is not supported.
The credentials that were supplied are not valid.
See also
Applies to
FindByName(DirectoryContext, String)
- Source:
- ActiveDirectorySiteLink.cs
- Source:
- ActiveDirectorySiteLink.cs
Returns a site link based on a site link name.
public:
static System::DirectoryServices::ActiveDirectory::ActiveDirectorySiteLink ^ FindByName(System::DirectoryServices::ActiveDirectory::DirectoryContext ^ context, System::String ^ siteLinkName);
public static System.DirectoryServices.ActiveDirectory.ActiveDirectorySiteLink FindByName (System.DirectoryServices.ActiveDirectory.DirectoryContext context, string siteLinkName);
static member FindByName : System.DirectoryServices.ActiveDirectory.DirectoryContext * string -> System.DirectoryServices.ActiveDirectory.ActiveDirectorySiteLink
Public Shared Function FindByName (context As DirectoryContext, siteLinkName As String) As ActiveDirectorySiteLink
Parameters
- context
- DirectoryContext
An DirectoryContext object that is valid for this site link.
- siteLinkName
- String
The name of the site link to find.
Returns
An ActiveDirectorySiteLink object for the requested site link.
Exceptions
The site could not be found for the given siteLinkName
in the context
specified.
A call to the underlying directory service resulted in an error.
The target server is either busy or unavailable.
The target in the context
parameter is not a forest, configuration set, domain controller, or an AD LDS server.
-or-
siteLinkName
is an empty string.
context
or siteLinkName
is null
.
The credentials that were supplied are not valid.