JevGetRegistGroupID
- Organization of this page
Description
This function acquires the source group ID as a basic attribute of the JP1 event.
Definition header
JevApi.h
Format
int JevGetRegistGroupID(long* lplStatus,
JP1EVENT event,
long* lplSize);
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).
lplSize
In lplSize, specify the pointer to the area for containing the event-originating group ID.
Return values
|
Situation |
Explanation |
|---|---|
|
Normal termination |
The function returns 0. Also, in the area specified in lplSize, the function stores the event-originating group ID. |
|
Abnormal termination |
The function returns -1. Also, in the area specified in lplStatus, the function stores the detailed error code. |