JevGetRegistTime (return value long type)
- Organization of this page
Description
This function acquires the time when the JP1 event was registered, as a basic attribute of the JP1 event. The time is represented by the number of seconds from 1970-01-01 00:00:00 (UTC). This function cannot be used in 2038 and beyond. If the arrival time acquired is 2038-01-19 03:14:07 or later, a return value of -1 will be returned.
Definition header
JevApi.h
Format
long JevGetRegistTime(long* lplStatus, JP1EVENT event);
Arguments
lplStatus
In lplStatus, specify the pointer to the area for containing the status code that this function returns if the function abnormally terminates. The following explains the status code.
Status code |
Meaning |
---|---|
JEV_S_PARAM_ERROR |
An invalid parameter is specified. |
JEV_S_EXTATTR_EOD |
This JP1 event does not include any additional extended attributes. (If the date is 2038-01-19 03:14:07 or later, this status code will be returned.) |
event
In event, specify the handle for accessing the target JP1 event (the return value of the JevGetEvent() function).
Return values
Situation |
Explanation |
---|---|
Normal termination |
The function returns the registration time (long type) of the JP1 event that can be referenced with the specified handle. |
Abnormal termination |
The function returns -1. Also, in the area specified in lplStatus, the function stores the detailed error code. |
Note
This function cannot be used in 2038 and beyond. Use the JevGetRegistTimeT() function or JevGetRegistTime() function (return value time_t type).