Decode String into Filename

This Subprogram will check that the specified string corresponds to a valid file specification, returning the full expanded filename if successful.

Short Name Calling Sequence

STATUS = UIDCFI(STRING,FILNAM[,FILLEN,EXISTS])

Long Name Calling Sequence

STATUS = UI_DECODE_FILENAME(...)

Input Arguments

STRING (Character) Text String

Output Arguments

FILNAM (Character) Expanded Filename FILLEN (Integer) Length of Filename (Optional) EXISTS (Logical) File exists flag (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__TRUNCATED ) Filename Truncated UIDFLT

UI__ILLEGAL_SYNTAX ) Illegal Syntax UIILSY ) Note:

1. The UI__ILLEGAL_SYNTAX Function Value will be returned if the text string does not conform to a correct Filename syntax. No modification will be made to the FILNAM Argument in this case.
2. The UI__TRUNCATED Function Value indicates that the full filename specifiation overflowed the FILNAM Argment and has therefore been truncated.
3. The FILLEN Argument is optional and, if present, will return the length (in characters) of the expanded file specification after any truncation.
4. The EXISTS Argument is optional and, if present, will indicate whether the file exists or not.
5. All Errors are informational only, no Error Message will be issued.
6. Any leading or trailing spaces or tabs within STRING will be ignored.
7. See UI_GET_FILENAME for further notes on Arguments.