TeGetKeyCommand Function

Microchip Graphics Library

Microchip Graphics Library
TeGetKeyCommand Function
C
WORD TeGetKeyCommand(
    TEXTENTRY * pTe, 
    WORD index
);
Overview

This function will return the currently used command by a key with the given index.

Input Parameters
Input Parameters 
Description 
TEXTENTRY * pTe 
pointer to the object 
WORD index 
index to the key in the link list 
Returns

It will return the command ID currently set for the key. If the given index is not in the list the function returns zero. 0x00 - no command is assigned or the index given does not exist. 0x01 - TE_DELETE_COM 0x02 - TE_SPACE_COM 0x03 - TE_ENTER_COM

Preconditions

none

Side Effects

none.

Microchip Graphics Library Version 3.06.02 - October 15, 2012
Copyright © 2012 Microchip Technology, Inc.  All rights reserved