FBDirMap Class Reference

#include <pyfbsdk_generated.h>

Inheritance diagram for FBDirMap:

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

Member Function Documentation

Add()

Add	(	str	pSourceDir,
		str	pTargetDir
	)

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.

Clear()

Clear

(

)

Clears the map.

GetCount()

int GetCount

(

)

Returns the number of items in the map.

GetSource()

str GetSource

(

int

pIndex

)

Returns the source directory for the element at specified index.

GetTarget()

str GetTarget

(

int

pIndex

)

Returns the target directory for the element at specified index.

Map()

str Map

(

str

pPath

)

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

pPath

The path to process