ProSoft Technology MVI56E-LDM - Manual (Page 165)

ControlLogix Platform ♦ "C" Programmable CIP API Functions
Linux Application Development Module Developer's Manual
ProSoft Technology, Inc. Page 159 of 264
March 12, 2014
OCXcip_GetWCTimeUTC
Syntax
int OCXcip_GetWCTimeUTC (OCXHANDLE apihandle,
BYTE *pPathStr,
OCXCIPWCT *pWCT,
WORD timeout);
Parameters
apihandle handle returned by previous call to OCXcip_Open
pPathStr path to device being read
pWCT Pointer to OCXCIPWCTUTC structure to be filled with Wall Clock
Time data
timeout number of milliseconds to wait for the read to complete
Compatibility
This function is compatible only with Logix controllers with v16 or greater
firmware installed. Firmware versions below v16 will result in error
OCX_CIP_INVALID_REQUEST
. For previous firmware versions, use
OCXcip_GetWCTime()
.
Description
OCXcip_GetWCTimeUTC
retrieves information from the Wall CLock object in the
specified device. The time returned is expressed as UTC time.
apihandle
must be a valid handle returned from
OCXcip_Open
.
pPathStr must be a pointer to a string containing the path to a device which
supports the Wall Clock Time object, such as a ControlLogix controller.
pWCT
may point to a structure of type
OCXCIPWCTUTC
, which on success will be filled
with the data read from the device. As a special case,
pWCT
may also be NULL.
If
pWCT
is NULL, the system time is set with the UTC time returned from the WCT
object. This is a convenient way to synchronize the system time with the
controller time (Note: The user account must have appropriate privileges to set
the system time.)
timeout is used to specify the amount of time in milliseconds the application
should wait for a response from the device.
The following example defines the
OCXCIPWCTUTC
structure:
typedef struct tagOCXCIPWCT
{
ULARGE_INTEGER CurrentUTCValue;
char TimeZone[84];
int DSTOffset;
int DSTEnable;
SYSTEMTIME SystemTime;
} OCXCIPWCTUTC;