MtrTranslateMsg Function

Microchip Graphics Library

previous page next page

Microchip Graphics Library

WORD MtrTranslateMsg(
    void * pObj, 
    GOL_MSG * pMsg
);

Overview

This function evaluates the message from a user if the message will affect the object or not. The table below enumerates the translated messages for each event of the touch screen and keyboard inputs.

Translated Message	Input Source	Events	Description
MTR_MSG_SET	System	EVENT_SET	If event set occurs and the meter ID is sent in parameter 1.
OBJ_MSG_INVALID	Any	Any	If the message did not affect the object.

Input Parameters

Input Parameters	Description
GOL_MSG * pMsg	Pointer to the message struct containing the message from the user interface.
pMtr	The pointer to the object where the message will be evaluated to check if the message will affect the object.

Returns

Returns the translated message depending on the received GOL message:

MTR_MSG_SET - Meter ID is given in parameter 1 for a TYPE_SYSTEM message.
OBJ_MSG_INVALID - Meter is not affected.

Preconditions

none

Side Effects

none

Library API > Graphics Object Layer API > GOL Objects > Meter > MtrTranslateMsg Function

Contents | Index | Home

previous page start next page