JevGetMessage
- Organization of this page
Description
This function acquires the message in the JP1 event as a basic attribute of the JP1 event.
Definition header
JevApi.h
Format
int JevGetMessage(long* lplStatus, JP1EVENT event, 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 code.
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).
lppszValue
In lppszValue, specify the pointer to the area for storing the pointer to the acquired message. When the corresponding data does not exist, a NULL pointer is set.
Return values
Situation |
Explanation |
---|---|
Normal termination |
The function returns 0. Also, in the area specified in lppszValue, the function stores the pointer to the message. |
Abnormal termination |
The function returns -1. Also, in the area specified in lplStatus, the function stores the detailed error code. |