Hitachi

JP1 Version 13 JP1/Base Function Reference


JevGetArrivedTime (return value time_t type)

Organization of this page

Description

This function acquires the time when the JP1 event arrived, 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 returns a time_t type return value.

When using this function, specify D_JEVTIME_T as the compile option when compiling.

Definition header

JevApi.h

Format

time_t JevGetArrivedTime(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.

Table 3‒5:  Status code and meaning (JevGetArrivedTime)

Status code

Meaning

JEV_S_PARAM_ERROR

An invalid parameter is specified.

event

In event, specify the handle for accessing the target JP1 event (the return value of the JevGetEvent() function).

Return values

Normal termination

The function returns the arrival time (time_t) 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.