TeCreateKeyMembers Function

Microchip Graphics Library

Microchip Graphics Library
TeCreateKeyMembers Function
C
KEYMEMBER * TeCreateKeyMembers(
    TEXTENTRY * pTe, 
    XCHAR * pText[]
);
Overview

This function will create the list of KEYMEMBERS that holds the information on each key. The number of keys is determined by the equation (verticalKeys*horizontalKeys). The object creates the information holder for each key automatically and assigns each entry in the *pText[] array with the first entry automatically assigned to the key with an index of 1. The number of entries to *pText[] must be equal or greater than (verticalKeys*horizontalKeys). The last key is assigned with an index of (verticalKeys*horizontalKeys)-1. No checking is performed on the length of *pText[] entries to match (verticalKeys*horizontalKeys).

Input Parameters
Input Parameters 
Description 
TEXTENTRY * pTe 
pointer to the object 
XCHAR * pText[] 
pointer to the text defined by the user 
Returns

Returns the pointer to the newly created KEYMEMBER list. A NULL is returned if the list is not created succesfully.

Preconditions

none

Side Effects

none.

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