Brief Index      Full Index      I.M. Reference

Show_Alias


Functions

void Show_Alias (const char *alias, char *expansion)

Function Documentation

void Show_Alias ( const char *  alias,
char *  expansion 
)

Returns the expansion of a given alias.

Parameters:
alias - Alias name from a previous Define_Alias() , including the initial "?". Passed by reference always.
expansion - The literal and precise string of characters that is equivalent to alias. Returned to user. Passed by reference always.

DETAILS

Returns the string of characters that is substituted for the given alias when used in a pathname. Expansion is returned exactly as specified in the call to Define_Alias() .

Relative pathnames (e.g., ".", "^") are not resolved. Aliases within an alias definition are not expanded. Use Show_Pathname_Expansion() to show the full segment specification corresponding to an alias; use Find_Segment() ( Begin_Segment_Search() ) to see if the segment exists.

NOTES

There are a few minor differences between expansion as returned here and as originally specified in Define_Alias() . Leading and trailing blanks in the alias definition will not be returned. Upper case letters will be returned in lower case. For example,
                Test Segment / (ASEG, bseg) /...
is returned as
                test segment/(aseg, bseg)/....
Also, segments defined by key value in the original Define_Alias() are always returned in uppercase, i.e., if the call was Define_Alias("?junk", "test segment/@ab12f34c") Show_Alias() will return "test segment/@AB12F34C".

RESTRICTIONS

See also:
Begin_Segment_Search, Begin_Alias_Search, Define_Alias, Show_Pathname_Expansion.

Main Index
Brief Index      Full Index      I.M. Functions