Hitachi

JP1 Version 12 JP1/Base Function Reference


JevGetDestinationServer

Organization of this page

Description

This function acquires the destination event server name as a basic attribute of the JP1 event.

Definition header

JevApi.h

Format

int JevGetDestinationServer(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.

Table 3‒9: Status code and meaning (JevGetDestinationServer)

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 destination event server name. 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 destination event server name.

Abnormal termination

The function returns -1. Also, in the area specified in lplStatus, the function stores the detailed error code.