AuthenticablePrincipal.FindByLogonTime 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.
Overloads
| FindByLogonTime(PrincipalContext, DateTime, MatchType) |
Returns a collection of authentication principal objects that have an account logon recorded in the specified date and time range. |
| FindByLogonTime<T>(PrincipalContext, DateTime, MatchType) |
Returns a PrincipalSearchResult<T> collection of objects that have a logon time within the specified date and time range. This is the template function for extended classes that wish to implement this functionality. |
FindByLogonTime(PrincipalContext, DateTime, MatchType)
- Source:
- AuthenticablePrincipal.cs
- Source:
- AuthenticablePrincipal.cs
Returns a collection of authentication principal objects that have an account logon recorded in the specified date and time range.
public:
static System::DirectoryServices::AccountManagement::PrincipalSearchResult<System::DirectoryServices::AccountManagement::AuthenticablePrincipal ^> ^ FindByLogonTime(System::DirectoryServices::AccountManagement::PrincipalContext ^ context, DateTime time, System::DirectoryServices::AccountManagement::MatchType type);public static System.DirectoryServices.AccountManagement.PrincipalSearchResult<System.DirectoryServices.AccountManagement.AuthenticablePrincipal> FindByLogonTime (System.DirectoryServices.AccountManagement.PrincipalContext context, DateTime time, System.DirectoryServices.AccountManagement.MatchType type);static member FindByLogonTime : System.DirectoryServices.AccountManagement.PrincipalContext * DateTime * System.DirectoryServices.AccountManagement.MatchType -> System.DirectoryServices.AccountManagement.PrincipalSearchResult<System.DirectoryServices.AccountManagement.AuthenticablePrincipal>Public Shared Function FindByLogonTime (context As PrincipalContext, time As DateTime, type As MatchType) As PrincipalSearchResult(Of AuthenticablePrincipal)Parameters
- context
- PrincipalContext
The PrincipalContext that specifies the server or domain against which operations are performed.
- time
- DateTime
A DateTime object that identifies the date and time of the logon record. This parameter is used with the type parameter to determine the range of time in which the returned objects have an account logon recorded.
- type
- MatchType
A MatchType enumeration value that specifies the type of match that is applied to the time parameter.
Returns
A PrincipalSearchResult<T> that contains one or more AuthenticablePrincipal objects.
Examples
The following code connects to the ADAM instance hosted by the server "adamHost1.fabrikam.com" on port number "5000." The username (adamAdmin), and password (SecretPwd123) are specified in the PrincipalContext constructor.
A search is performed for all authenticable principals under the container "DC=adamApp1,DC=fabrikam,DC=com" that have not logged on to this ADAM instance for the last 45 days. The principals returned by the search are then deleted.
PrincipalContext ctx = new PrincipalContext(
ContextType.ApplicationDirectory,
"adamHost1.fabrikam.com:5000",
"DC=adamApp1,DC=fabrikam,DC=com",
"adamAdmin", "SecretPwd123");
PrincipalSearchResult<AuthenticablePrincipal> oldPrincipals =
AuthenticablePrincipal.FindByLogonTime(ctx,
(DateTime.Now - new TimeSpan(45, 0, 0, 0)),
MatchType.LessThan);
foreach (Principal p in oldPrincipals)
{
p.Delete();
}
oldPrincipals.Dispose();
ctx.Dispose();
Remarks
The time will default to UTC. If you want to specify the time in local time, then specify the Kind property of the time object as DateTimeKind.Local.
Applies to
FindByLogonTime<T>(PrincipalContext, DateTime, MatchType)
- Source:
- AuthenticablePrincipal.cs
- Source:
- AuthenticablePrincipal.cs
Returns a PrincipalSearchResult<T> collection of objects that have a logon time within the specified date and time range. This is the template function for extended classes that wish to implement this functionality.
protected:
generic <typename T>
static System::DirectoryServices::AccountManagement::PrincipalSearchResult<T> ^ FindByLogonTime(System::DirectoryServices::AccountManagement::PrincipalContext ^ context, DateTime time, System::DirectoryServices::AccountManagement::MatchType type);protected static System.DirectoryServices.AccountManagement.PrincipalSearchResult<T> FindByLogonTime<T> (System.DirectoryServices.AccountManagement.PrincipalContext context, DateTime time, System.DirectoryServices.AccountManagement.MatchType type);static member FindByLogonTime : System.DirectoryServices.AccountManagement.PrincipalContext * DateTime * System.DirectoryServices.AccountManagement.MatchType -> System.DirectoryServices.AccountManagement.PrincipalSearchResult<'T>Protected Shared Function FindByLogonTime(Of T) (context As PrincipalContext, time As DateTime, type As MatchType) As PrincipalSearchResult(Of T)Type Parameters
- T
Parameters
- context
- PrincipalContext
The PrincipalContext that specifies the server or domain against which operations are performed.
- time
- DateTime
A DateTime object that identifies the date and time of the password set. This parameter is used with the type parameter to determine the range of time in which the returned objects have a password set recorded.
- type
- MatchType
A MatchType enumeration value that specifies the type of match that is applied to the time parameter.
Returns
A PrincipalSearchResult<T> that contains one or more objects of the appropriate principal type, or an empty collection if no matches are found.
Remarks
The time will default to UTC. If you want to specify the time in local time, then specify the Kind property of the time object as DateTimeKind.Local.
