ICELIB0.NLM → ICE_FindCmd()

ICE_FindCmd

Description:

Returns a 32-bit value (which can also be an address) based on the command found in a master list.

Syntax for C:

int ICE_FindCmd (
char *command,
char **commandList,
unsigned int flags
);

Syntax for Assembly:

Call ICE_FindCmd C, offset command, offset commandlist, [flags]

Parameters:

command: (IN) Pointer to ASCIIZ string containing command to search for.
commandList: (IN) Pointer to specialized structure of commands and their associated 32-bit values (which can also be addresses of functions or data).
flags: (IN) Some rules to be enforced during comparison. All undocumented bit flags are considered reserved for future use, and should remain cleared (0) to ensure upward compatibility with newer versions of ICELIB0.NLM. Currently supported flags are as follows:
1 = Perform a lower-case comparison (uses a dynamically allocated copy of command, converted to lower case, but commandList entries must also be in lower-case for this to work)

Returns:

-1 if unsuccessful (no match), or if "command" or "commandList" are NULL pointers, otherwise the associated 32-bit value is returned.

Remarks:

Reduces software development time and overhead by simplifying the task of handling user keystrokes, commands, and anything else that would normally require multiple comparisons to process input.

Resource files:

icelib0.imp

Structures:

commandList: ASCIIZ string, 32-bit value, ASCIIZ string, 32-bit value, ..., NULL

Minimum library version:

1.07