Hitachi

JP1 Version 12 JP1/Base Function Reference


JevGetNextExtAttr

Organization of this page

Description

This function acquires the next specified extended attribute of a JP1 event after an extended attribute is acquired by a JP1 JevGetFirstAttr() or a JevGetNextAttr() event acquisition function.

Definition header

JevApi.h

Format

int JevGetNextExtAttr(long* lplStatus,
                      JP1EVENT event,
                      const char** const lppszName,
                      const char** const lppszValue);

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 codes that may be returned.

Table 3‒16: Status codes and meanings (JevGetNextExtAttr)

Status code

Meaning

JEV_S_PARAM_ERROR

An invalid parameter is specified.

JEV_S_EXTATTR_EOD

This JP1 event includes no more extended attributes.

event

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

lppszName

In lppszName, specify the pointer to the area for storing the pointer to the acquired extended attribute name.

lppszValue

In lppszValue, specify the pointer to the area for storing the pointer to the acquired extended attribute value.

Return values

Situation

Explanation

Normal termination

The function returns 0 and, in the area specified in lppszName, stores the pointer to the next extended attribute name. Also, in the area specified in lppszValue, the function stores the pointer to the next extended attribute value.

Abnormal termination

The function returns -1. Also, in the area specified in lplStatus, the function stores the detailed error code.