IsApplicable
Checks to see if the role is valid at a specified time.
Syntax
bool IsApplicable(int dayOfWeek, int hourOfDay)
Parameter
Specify the following parameters when using this method.
Parameter | Description |
---|---|
dayOfWeek
|
The day of the week, where 0 is Sunday and 6 is Saturday. |
hourOfDay
|
The hour of the day, where 0 is midnight and 23 is 11:00 PM |
Return value
Returns true
if the role is valid at the specified time.
Discussion
If the role is active at a particular hour, it is active for that entire hour.
To set a specific hour, see SetApplicableHour
. To set an entire day, see
GetSshRight
. To set up an entire schedule with one call, see
ApplicableTimeHexString
.