Open Reality Reference Guide
FBDirMap Class Reference

Static Public Member Functions

static void Add (FBString pSourceDir, FBString pTargetDir)
 Adds an entry in the map. More...
 
static int GetCount ()
 Returns the number of items in the map. More...
 
static FBString GetSource (int pIndex)
 Returns the source directory for the element at specified index. More...
 
static FBString GetTarget (int pIndex)
 Returns the target directory for the element at specified index. More...
 
static void Clear ()
 Clears the map. More...
 
static FBString Map (FBString pPath)
 Iterates through all the mapped directories. More...
 

Detailed Description

Definition at line 767 of file fbsystem.h.

Member Function Documentation

◆ Add()

static void Add ( FBString  pSourceDir,
FBString  pTargetDir 
)
static

Adds an entry in the map.

Environment variables can be specified for the target path using the syntax. Environment variables are expanded before the paths get added to the map. An error in the formatting of the paths (environment variable tokens) will abort the expansion and both given paths will remained unchanged.

\param  pSourceDir The source directory
\param  pTargetDir The target directory

◆ Clear()

static void Clear ( )
static

Clears the map.

◆ GetCount()

static int GetCount ( )
static

Returns the number of items in the map.

◆ GetSource()

static FBString GetSource ( int  pIndex)
static

Returns the source directory for the element at specified index.

◆ GetTarget()

static FBString GetTarget ( int  pIndex)
static

Returns the target directory for the element at specified index.

◆ Map()

static FBString Map ( FBString  pPath)
static

Iterates through all the mapped directories.

If one of the mapped directory's source is found in the given path, that part of the path will be replaced by the mapped directory's target. Only the first occurrence is processed.

Parameters
pPathThe path to process

The documentation for this class was generated from the following file: