Previous IDL Reference Guide: Functional List of IDL Routines Next

Programming and IDL Control

APP_USER_DIR - Provides access to the application user directory.

APP_USER_DIR_QUERY - Locates existing application user directories.

ARG_PRESENT - Returns TRUE if the value of the specified variable can be passed back to the caller.

BIT_FFS - Returns the index of the first bit set (non-zero) in an integer.

BIT_POPULATION - Returns the number of set (non-zero) bits in an integer.

BREAKPOINT - Sets and clears breakpoints for debugging.

BYTEORDER - Converts between host and network byte ordering.

CALL_FUNCTION - Calls an IDL function.

CALL_METHOD - Calls an IDL object method.

CALL_PROCEDURE - Calls an IDL procedure.

CATCH - Declares and clears exception handlers.

COMMAND_LINE_ARGS - Returns string values supplied when the user starts IDL with the -arg or -args command line options.

CPU - Changes the values stored in the read-only !CPU system variable.

CREATE_STRUCT - Creates and concatenates structures.

COMPILE_OPT - Change default rules for compiling routines.

DEFINE_KEY - Programs keyboard function keys.

DEFINE_MSGBLK - Defines and loads a new message block into the current IDL session.

DEFINE_MSGBLK_FROM_FILE - Reads the definition of a message block from a file, and loads it into the current IDL session.

DEFSYSV - Creates a new system variable.

EXECUTE - Compiles, executes IDL statements contained in a string.

EXIT - Quits IDL and exits back to the operating system.

EXPAND_PATH - Expands path-definition string into full path name for use with the !PATH system variable.

HEAP_FREE - Recursively frees all heap variables referenced by its input argument.

HEAP_GC - Performs "garbage collection" on heap variables.

HEAP_NOSAVE - Used to clear the save attribute of pointer or object heap variables.

HEAP_SAVE - Used to query whether a pointer or object heap variable is savable. It can also be used to change the heap variable save attribute.

IDL_VALIDNAME - Determines whether a string may be used as a valid IDL variable name or structure tag name.

IDLITSYS_CREATETOOL - Creates an instance of the specified tool registered within the iTools system.

ITCURRENT - Set the current tool in the iTools system.

ITDELETE - Deletes a tool in the iTools system.

ITGETCURRENT - Gets the identifier of the current tool in the iTools system.

ITREGISTER - Registers tool object classes with the iTools system.

ITRESET - Resets the iTools session.

ITRESOLVE - Resolves all IDL code within the iTools directory, as well as all other IDL code required for the iTools framework.

KEYWORD_SET - Returns True if given expression is defined and nonzero or an array.

LMGR - Determines the type of license used by the current IDL session.

LOGICAL_AND - Performs a logical AND operation on its arguments.

LOGICAL_OR - Performs a logical OR operation on its arguments.

LOGICAL_TRUE - Determines whether its arguments are non-zero (or non-NULL).

MESSAGE - Issues error and informational messages.

N_ELEMENTS - Returns the number of elements contained in an expression or variable.

N_PARAMS - Returns the number of non-keyword parameters used in calling an IDL procedure or function.

N_TAGS - Returns the number of tags in a structure.

OBJ_CLASS - Determines the class name of an object.

OBJ_DESTROY - Destroys an object reference.

OBJ_HASMETHOD - Determines whether an object class implements or inherits a specified method or methods.

OBJ_ISA - Determines inheritance relationship of an object.

OBJ_NEW - Creates an object reference.

OBJ_VALID - Verifies validity of object references.

ON_ERROR - Designates the error recovery method.

ON_IOERROR - Declares I/O error exception handler.

PATH_CACHE - Controls IDL's path caching mechanism.

PREF_COMMIT - Commits IDL preferences in the pending state.

PREF_GET - Returns information about IDL preferences.

PREF_MIGRATE - Imports IDL preferences from other versions of IDL for use by the currently running version.

PREF_SET - Sets new values for IDL preferences.

PTR_FREE - Destroys a pointer.

PTR_NEW - Creates a pointer.

PTR_VALID - Verifies the validity of pointers.

PTRARR - Creates an array of pointers.

RECALL_COMMANDS - Returns entries in IDL's command recall buffer.

REGISTER_CURSOR - Associates a given name with cursor information, used in conjunction with IDLgrWindow::SetCurrentCursor.

RESOLVE_ALL - Compiles any uncompiled routines.

RESOLVE_ROUTINE - Compiles a routine.

RETALL - Returns control to the main program level.

RETURN - Returns control to the next-higher program level.

ROUTINE_INFO - Provides information about compiled procedures and functions.

STOP - Stops the execution of a running program or batch file.

STRMESSAGE - Returns the text of a given error number.

STRUCT_ASSIGN - Uses "Relaxed Structure Assignment" to copy structures.

STRUCT_HIDE - Prevents the IDL HELP procedure from displaying information about structures or objects.

SWAP_ENDIAN - Reverses the byte ordering of scalars, arrays or structures.

SWAP_ENDIAN_INPLACE - Reverses the byte ordering of scalars, arrays or structures. Differs from the SWAP_ENDIAN function in that it alters the input data in place rather than making a copy.

TAG_NAMES - Returns the names of tags in a structure.

TEMPORARY - Returns a temporary copy of a variable, and sets the original variable to "undefined".

WAIT - Suspends execution of an IDL program for a specified period.

  IDL Online Help (March 06, 2007)