wiki:Documentation/ARexxAPI/GETFOLDERINFO

Version 3 (modified by AmigaPhil, 13 months ago) (diff)

--

Languages:


ARexx API

    GETFOLDERINFO

    NAME

    GetFolderInfo -- Return information about the current folder.

    TEMPLATE

    VAR/K,STEM/K,ITEM/A

    FUNCTION

    Returns information about the current folder.

    INPUTS

    VAR/K - alternative variable to put the results into instead of RESULT (V2.0)
    STEM/K - base name used for the stems where the returned data will be stored (V2.0)
    ITEM/A - item to return info about, may be one of

    NUM(BER) - position in the folder list (0 = first folder)
    NAM(E) - name of the folder as shown in the folder list
    MAX - total number of messages in the folder
    PAT(H) - folder directory, without path (V1.3)

    RETURNS

    VAR - info returned by the query
    <STEM>VALUE - info returned by the query

    NOTES

    Superseded by FOLDERINFO ? in V2.0+. Don't use it in new scripts.

    EXAMPLE

    /* Enable result codes */

    OPTIONS RESULTS

    /* Request info */

    GETFOLDERINFO NUMBER VAR position
    GETFOLDERINFO NAME VAR name
    GETFOLDERINFO MAX VAR total
    GETFOLDERINFO PATH VAR path

    /* Display results */

    SAY 'Folder name: 'name
    SAY 'Path: 'path
    SAY 'Place in list: 'position
    SAY 'Total messages: 'total

    BUGS

    SEE ALSO

    FOLDERINFO ?