_FindVar( ) API Library Routine

See Also   Example

Provides a way to initialize a Locator so you can use _Store( ) to place data in an existing memory variable or field.

Syntax

int _FindVar(NTI nti, int where, Locator FAR *loc)
NTI nti;                     /* NTI number of variable or field. */
int where;                  /* Work area number. */
Locator FAR *loc;            /* Locator. */

Remarks

_FindVar( ) fills in the passed Locator with information about a variable or field named nti that exists in a work area specified by where.

• If where is  – 1, nti is assumed to be a memory variable.
  
  
• If where is 1 – 225, nti is assumed to be a field in the work area of the specified number.
  
  
• If where is 0, _FindVar first checks to see if nti is a memory variable. If it's not a memory variable, the current work area is checked for a field with the specified NTI.

_FindVar( ) returns True (an integer other than 0) if a variable or field nti is found in where; otherwise, _FindVar( ) returns False (0).

For more information on how to create an API library and integrate it with Visual FoxPro, see Chapter 28, Accessing the Visual FoxPro API, in the Programmer's Guide.