Appendix D: Clock Manager NetLinx Programming API
143
NX-Series Controllers - WebConsole & Programming Guide
NetLinx.axi - Library Calls (Cont.)
CLKMGR_GET_TIMESERVERS
(CLKMGR_TIMESERVER_STRUCT T[])
Populates the currently configured time server entries from the Clock
Manager into the specified TIMESERVER array.
The function returns a negative SLONG value if it encounters an error,
otherwise the return value is set to the number of records populated into the
CLK-MGR_-TIMESERVER_STRUCT array.
CLKMGR_ADD_USERDEFINED_TIMESERVER
(CONSTANT CHAR IP[], CONSTANT CHAR URL[],
CONSTANT CHAR LOCATION[])
Adds a user-defined time server entry.
CLKMGR_DELETE_USERDEFINED_
TIMESERVER(CONSTANT CHAR IP[])
Deletes the user-defined entry that has its IP-ADDRESS matching the
parameter.
CLKMGR_GET_START_
DAYLIGHTSAVINGS_RULE()
Gets a string representation of when Daylight Savings is supposed to START.
The Fixed-Date rules have the form:
"fixed:DAY,MONTH,HH:MM:SS"
with all fields as numeric except for the word "fixed".
The Occurrence-Of-Day rules have the form:
"occurence:OCCURENCE,DAY-OF-WEEK,MONTH,HH:MM:SS"
with all fields as numeric except for the word "occurence".
• OCCURANCE range = 1-5
’5’ indicates the 'LAST' occurrence of a particular day of the month.
• DAY-OF-WEEK translates as:
1=Sunday
2=Monday
3=Tuesday
4=Wednsday
5=Thursday
6=Friday
7=Saturday
Examples:
"fixed:5,10,16:00:00" = October 5, at 4:00PM).
"occurence:5,1,10,02:00:00" = last Sunday in October, at 2:00AM).
CLKMGR_SET_START_DAYLIGHTSAVINGS_RULE
(CONSTANT CHAR RECORD[])
Sets the START Daylight Savings rule to the specified string which
must
be in
either the Fixed-Date format or the Occurence-Of-Day format. The function
returns a negative SLONG value if it encounters an error.
The Fixed-Date rules have the form:
"fixed:DAY,MONTH,HH:MM:SS"
with all fields as numeric except for the word "fixed".
The Occurrence-Of-Day rules have the form:
"occurence:OCCURENCE,DAY-OF-WEEK,MONTH,HH:MM:SS"
with all fields as numeric except for the word "occurence".
• OCCURANCE range = 1-5
’5’ indicates the 'LAST' occurrence of a particular day of the month.
• DAY-OF-WEEK translates as:
1=Sunday
2=Monday
3=Tuesday
4=Wednsday
5=Thursday
6=Friday
7=Saturday
Examples:
"fixed:5,10,16:00:00" = October 5, at 4:00PM).
"occurence:5,1,10,02:00:00" = last Sunday in October, at 2:00AM).