Define_Alias

Functions

void Define_Alias (const char *name, const char *expansion)
 Permits a "shorthand" name to be used in place of a longer proper name of a segment. More...
 
void UnDefine_Alias (const char *name)
 Removes all settings established by a previous call to Define_Alias(). More...
 

Detailed Description

Function Documentation

◆ Define_Alias()

void Define_Alias ( const char *  name,
const char *  expansion 
)

Permits a "shorthand" name to be used in place of a longer proper name of a segment.

Parameters
name- Simple name to be added to the list of definitions.
expansion- The literal and precise string of characters that should be substituted for name.

DETAILS


 
 

Sometimes full segment tree names will get too lengthy to carry around. Sometimes a utility package would like to define or refer to a fixed special segment name (for example, "?Active Window"). Or sometimes you might want to hide unnecessary details (such as a special name required for the current hardcopy device) from the higher levels of your program. In such cases, Define_Alias() allows you to establish substitutions to be made. All aliases begin with a "?", and all names that begin with a "?" in a segment specification must be in the system's list of aliases.

The expansion of an alias can include wildcard characters, references to other names, or anything you want. The expansion is substituted literally when the alias is encountered and execution continues. At definition time, the expansion is simply recorded.

The defined name must include the leading "?".

NOTE
 
 

A warning is given for redefining an already existing name.

NOTES

RESTRICTIONS

See also
, Open_Segment, Flush_Contents, Include_Segment, Style_Segment, Define_Color_Name.

◆ UnDefine_Alias()

void UnDefine_Alias ( const char *  name)

Removes all settings established by a previous call to Define_Alias().

Parameters
name- Simple name to be added to the list of definitions.

DETAILS

No additional details. See Define_Alias()