Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kPath_ToRelative ( const kChar pathA,
const kChar pathB,
kChar bRelativeToA,
kSize  capacity 
)

Expresses an absolute path in relative form, in relation to a reference path.

If pathA and pathB are rooted in different volumes, then bRelativeToA will receive an absolute path equal to pathB.

The bRelativeToA (output) argument can refer to the same memory address as either the pathA or pathB (input) arguments.

Parameters
pathAAbsolute reference path.
pathBAbsolute path to be re-expressed as relative to path A.
bRelativeToAReceives path b, expressed as relative to path A.
capacityMaximum number of characters (including null terminator) for the relative path.
Returns
Operation status.