Función ghDirPath

[[Al González]]

Forma una ruta de archivo o directorio, concatenando parte de otra ruta y una ruta parcial. Es decir, permite obtener una ruta relativa a otra.

Unidad

GHFRTL

Declaración

Código Delphi [-]
  { Directory Path }
  Function ghDirPath (Const Path :String; Const UpLevels :Integer;
    Const SubPath :String; Const APathDelim :Char = PathDelim) :String;
    Overload;

  { Directory Path }
  Function ghDirPath (Const Path, SubPath :String;
    Const APathDelim :Char = PathDelim) :String; Overload;

  { Directory Path }
  Function ghDirPath (Const UpLevels :Integer; Const SubPath :String;
    Const APathDelim :Char = PathDelim) :String; Overload;

  { Directory Path }
  Function ghDirPath (Const SubPath :String;
    Const APathDelim :Char = PathDelim) :String; Overload;

Descripción

La función ghDirPath toma una ruta de archivo dada (Path), la cual trunca hasta cierto directorio para luego concatenarla con la ruta SubPath, devolviendo la cadena de caracteres que resulta de esa concatenación. El parámetro UpLevels indica cuántos niveles debe "subir" para obtener la subruta de Path. El parámetro APathDelim sirve para indicar cuál es el carácter utilizado para delimitar las distintas partes de una ruta.

ghDirPath primero llama a la función ghDir con los parámetros Path, UpLevels y APathDelim, y luego añade la ruta SubPath a la cadena de caracteres que ghDir devolvió, con el carácter APathDelim de por medio.

Parámetros

Path — Una cadena de caracteres que exprese una ruta de archivo, directorio o algo similar. Si es una cadena vacía, el resultado será el valor de SubPath. Este parámetro puede omitirse, su valor predeterminado es la ruta completa del programa ejecutable.

UpLevels — Indica la cantidad de partes de la ruta Path que la función contará de derecha a izquierda para determinar el final de la subcadena a unir con SubPath. Este parámetro puede omitirse, su valor predeterminado es 1.

SubPath — Una cadena de caracteres que exprese una ruta parcial de archivo, directorio o algo similar. Si es una cadena vacía, el resultado será el mismo que haya regresado la función ghDir.

APathDelim — Indica cuál es el carácter que se emplea para separar las partes de una ruta. Este parámetro puede omitirse, su valor predeterminado es el de la constante nativa PathDelim.

Ejemplos

Código Delphi [-]
  S := ghDirPath ('C:\Program Files\Embarcadero\RAD Studio\9.0\Source',
    'Lib');
  // S = 'C:\Program Files\Embarcadero\RAD Studio\9.0\Lib'

  S := ghDirPath ('C:\Program Files\Embarcadero\RAD Studio\9.0\Bin', 2,
    '11.0\Bin');
  // S = 'C:\Program Files\Embarcadero\RAD Studio\11.0\Bin'

  // If the executable program is C:\Apps\MyApp\Bin\MyApp.exe
  S := ghDirPath ('Config.dat');
  // S = 'C:\Apps\MyApp\Bin\Config.dat'

  // If the executable program is C:\Apps\Tests\ghDirPath\Project1.exe
  S := ghDirPath (3, 'Docs\Readme.txt');
  // S = 'C:\Apps\Docs\Readme.txt'

  S := ghDirPath ('http://www.firebirdsql.org/en/documentation/',
    'community/', '/');
  // S = 'http://www.firebirdsql.org/en/community/'