JevFreeEvent
- Organization of this page
Description
This function deallocates the area containing a JP1 event that you can access by using the return value of a JevGetEvent() function.
Definition header
JevApi.h
Format
int JevFreeEvent(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.
|
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 0. |
|
Abnormal termination |
The function returns -1. Also, in the area specified in lplStatus, the function stores the detailed error code. |