Hitachi

JP1 Version 12 JP1/Base Function Reference


JevGetExtID

Organization of this page

Description

This function acquires the extended part of the event ID, as a basic attribute of the JP1 event. The extended part of the event ID is the last four bytes of the eight-byte event ID.

Definition header

JevApi.h

Format

long JevGetExtID(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‒13: Status code and meaning (JevGetExtID)

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

Situation

Explanation

Normal termination

The function returns the extended part of the ID 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.