CDir (MT5) - clase para obtener el índice del catálogo - librería para MetaTrader 5

A veces, surge la necesidad de salir fuera del «entorno protegido» (sandbox) y leer el índice, comprobar la existencia de un archivo o una carpeta en el sistema de archivos. Además, puede que sea necesario averiguar los atributos del archivo o directorio, tamaño del archivo, hora de su creación, del último acceso o escritura. El código de abajo representa un ejemplo de la posible solución de estas tareas:

El prólogo estándar y la descripción de las variables, así como el enlace al código fuente de la clase de inclusión #include <WIN_API\Dir_API.mqh> es una instrucción explícita al compilador de que tiene que buscar este archivo en el directorio \MQL5\Include\WIN_API. Si desea, puede cambiar este enlace en función de sus preferencias respecto a la organización del trabajo con archivos de inclusión, usando el manual de referencia.

//+------------------------------------------------------------------+
//|                                            ExampleDirClass.mq4/5 |
//|                                        Copyright © 2017, Avatara |
//|                            https://www.mql5.com/en/users/avatara |
//+------------------------------------------------------------------+
#property copyright "Copyright © 2017, Avatara"            2017/02/12
#property link      "https://www.mql5.com/en/users/avatara"
#property description "-- Example Dir Class --------------"
#property strict
#include <WIN_API\Dir_API.mqh> 
//+------------------------------------------------------------------+
//| Script program start function                                    |
//+------------------------------------------------------------------+
void OnStart()
  {
   File_Def File;            // work structure
   CDir Dir; int total,i;     
   string path = TerminalInfoString(TERMINAL_COMMONDATA_PATH)+
               "\\..\\..\\Terminal";
//---    
  

Como podemos observar, la variable string path incluye la ruta hacia la carpeta que se ubica a dos niveles por encima de la ubicación estándar de la carpeta del terminal iniciado, y en caso de no usar la opción /portable, obtendremos la ruta hacia la carpeta que contiene los datos personalizados de todos los terminales de cliente de este usuario.

Un lector reflexivo dirá que hacemos unos movimientos extra, bastará con subir a un nivel y nos encontraremos en la carpeta necesaria. ¿Y si queremos navegar a otra carpeta, por ejemplo a Crashes o Tester? Para nuestro ejemplo es más instructivo.

Volvamos al código del ejemplo.

/---    
   total = Dir.Create(path);       // init dir
   Print (path," Total=",total-3); //Common,Help && Community not calc
    for (i = 0;i<total;i++)
    {
     string nameFile = Dir.GetNameFile(i);
     if(nameFile == "Common"||nameFile=="Help"||nameFile=="Community")
                                                              continue;
     File = Dir.GetStruct(i);
     Print (StringFormat ("%37s \t%8X\t  %5s\t",nameFile,
     File.FileAttributes,File.isDir?"-SubDir-":""),
     File.isDir?"            ":IntegerToString(File.FileLength,12),
     File.CreationTime,"     ",File.LastWriteTime,"     ",
     File.LastAccessTime);
    }
    Dir.Clear(); 
//---    

Teniendo creada la instancia de la clase, recibimos el número de elementos (archivos subcarpetas) en la variable total. Organizando el ciclo, imprimimos la lista de carpetas de los terminales (saltando los directorios compartidos). Vamos a ilustrar el acceso a los datos de la instancia con el acceso a la copia de la estructura de trabajo de datos de la clase File.

  path=TerminalInfoString(TERMINAL_PATH)+
              "\\..";
    Dir.Create(path,"\\M*");   // use filter "M*"       
    Print ("Alternative access:");
    total = Dir.Size(); 
    Print (Dir.Path," Total=",total);
    for (i = 0;i<total;i++)
    {
    Print  (StringFormat("%57s \t%8X \t %s \t",Dir.GetNameFile(i), 
                         Dir.GetStruct(i).FileAttributes,
                         Dir.isDir(i)?"--- SubDir ---": 
                         IntegerToString(Dir.GetFileLength(i),14)),
    "\t   Last modify: ",Dir.GetLastWriteTime(i));
    }
//---    
    Dir.Clear();  

En el ejemplo de la impresión de una parte del índice del directorio (se usa la selección de los elementos que contienen la M al principio) se demuestran otros métodos del trabajo con los elementos de la clase.

En la siguiente parte del código, comprobamos la existencia de un archivo especificado y buscamos su longitud.

//---  Use to check the file
    path="C:";
    Print("------------ Use to check the file ---------------------");
    stringfilter="\\pagefile.sys";
    Dir.Create(path,filter);
    total=Dir.Size();
    PrintFormat("Find %d entry.",total);
    if(total>0)
      for(i =0;i<total;i++)Print("File search \"",path,filter,
        "\" is return:",Dir.isDir(i)?"--- SubDir ---  "+
        Dir.GetNameFile(i):Dir.GetNameFile(i)+
        IntegerToString(Dir.GetFileLength(i),14)+" byte. \t",
        StringFormat("Atributes=%X",Dir.GetAtributes(i)));
    else  Print("File ",path,filter," is absent.");
//---
    Dir.Clear();              

Finalizamos el script de prueba con el ejemplo del uso de la referencia a la instancia de la clase de almacenamiento del elemento del índice del directorio:

  //--- use pointer to access data
   path="C:\\Temp";
    //---------------------> pointer declarate
    CDir_API *e;
  
    Print("------ Pointer use example. --------");
    total =Dir.Create(path);
    PrintFormat("%s       Find %d entry.",path,total);
    if(total>0)
      for(i =0;i<total;i++)
      {
      e=Dir.GetPointers(i);
      Print(StringFormat("%77s \t%8X\t  %5s\t ",e.Name_File,
          e.FileDef.FileAttributes,e.FileDef.isDir?"-SubDir-":""),
          e.FileDef.isDir?"         ":
          IntegerToString(e.FileDef.FileLength,12),"   ",
          e.FileDef.CreationTime,"     ",
          e.FileDef.LastWriteTime,"     ",
          e.FileDef.LastAccessTime);
      }  
    else  Print("File ",path,filter," is absent.");
//---
    Dir.Clear();
    Print("------------- The end. -----------------------");
}
//+------------------------------------------------------------------+

No me cabe la menor duda de que la mayoría de los lectores utilizará en su trabajo precisamente este método del acceso a los datos de la clase.

Para descifrar los atributos, puede necesitar la información adicional:

Espero que este ejemplo, como la propia clase, les sea de utilidad, y yo no les haya agotado mucho con mis explicaciones... ;)

¡Disfrútenlo!