JevGetFirstExtAttr
- Organization of this page
Description
This function acquires the first extended attribute specified in the JP1 event.
Definition header
JevApi.h
Format
int JevGetFirstExtAttr(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.
|
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. When the corresponding data does not exist, a NULL pointer is set.
Return values
|
Situation |
Explanation |
|---|---|
|
Normal termination |
The function returns 0 and, in the area specified in lppszName, stores the pointer to the extended attribute name. Also, in the area specified in lppszValue, the function stores the pointer to the extended attribute value. |
|
Abnormal termination |
The function returns -1. Also, in the area specified in lplStatus, the function stores the detailed error code. |