wiki:es:Documentation/ARexxAPI/FOLDERINFO

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

--

En otros idiomas:


ARexx API

    FOLDERINFO

    NOMBRE

    FolderInfo -- Obtener información sobre una carpeta. (V2.0)

    PLANTILLA

    VAR/K,STEM/K,FOLDER

    FUNCIÓN

    Devuelve información sobre una determinada carpeta, o sobre la carpeta actual si no se indica ninguna.

    ENTRADAS

    VAR/K - variable donde se almacenará el resultado
    STEM/K - nombre base usado por los STEMs donde se almacenará la información resultante
    FOLDER - nombre o senda de la carpeta de la que se quiere obtener información; si se omite, se utilizará la carpeta actual (V2.2)

    RESULTADOS

    VAR - cadena con una lista de los resultados del comando, separados por un espacio
    <STEM>NUMBER - posición de la carpeta en la lista de carpetas; la primera carpeta ocupa la posición 0
    <STEM>NAME - nombre de la carpeta tal como aparece en la lista de carpetas
    <STEM>PATH - senda de la carpeta, por ejemplo "incoming"
    <STEM>TOTAL - número total de mensajes que hay en la carpeta
    <STEM>NEW - número de mensajes nuevos que hay en la carpeta
    <STEM>UNREAD - número de mensajes no leídos que hay en la carpeta
    <STEM>SIZE - tamaño de la carpeta, en bytes
    <STEM>TYPE - tipo de carpeta (V2.3), los posibles valores son:

    0 - normal
    1 - correo entrante
    2 - correo saliente
    3 - enviados (para la carpeta "Enviados")
    4 - correo borrado
    5 - correo enviado y recibido
    6 - correo enviado

    RC se pone a 10 si no se ha podido encontrar la carpeta indicada.

    NOTAS

    EJEMPLO

    /* Activar códigos de resultados */

    OPTIONS RESULTS

    /* Solicitar información */

    FOLDERINFO 'Incoming' STEM fi.

    /* Mostrar los resultados */

    SAY 'Carpeta número: 'fi.number
    SAY 'Nombre de la carpeta: 'fi.name
    SAY 'Senda: 'fi.path
    SAY 'Total de mensajes: 'fi.total
    SAY 'Mensajes nuevos: 'fi.new
    SAY 'Mensajes no leídos: 'fi.unread
    SAY 'Tamaño total: 'fi.size
    SAY 'Tipo: 'fi.type

    FALLOS

    VÉASE TAMBIÉN