JevGetExtAttrDirect
- Organization of this page
Description
This function acquires an extended attribute of the JP1 event.
Definition header
JevApi.h
Format
const char*JevGetExtAttrDirect(long* lplStatus,
JP1EVENT event,
const char* lpszName);
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_NOT_DEFINED |
The specified attribute is not defined. |
event
In event, specify the handle for accessing the target JP1 event (the return value of the JevGetEvent() function).
lpszName
In lpszName, specify the pointer to the character string that specifies the extended attribute name.
Return values
|
Situation |
Explanation |
|---|---|
|
Normal termination |
The function returns the extended attribute value of the JP1 event that can be referenced with the specified handle. |
|
Abnormal termination |
The function returns a null pointer. Also, in the area specified in lplStatus, the function stores the detailed error code. |