Chapter 6 Function Descriptions
FDepth
int32 FDepth(path);
Purpose
Computes the depth (number of component names) of a path.
Parameters
Name |
Type |
Description |
|
|
|
|
|
|
path |
Path |
Path whose depth you want to determine. |
|
|
|
Return Value
int32, indicating the depth of the path, which can contain the following values:
–1 |
Badly formed path. |
0 |
Path is the root directory. |
1 |
Path is in the root directory. |
2 |
Path is in a subdirectory of the root directory, one level from the |
|
root directory. |
n–1 |
Path is n–2 levels from the root directory. |
N |
Path is n–1 levels from the root directory. |
6-59 |
Using External Code in LabVIEW |
Chapter 6 Function Descriptions
FDirName
MgErr FDirName(path, dir);
Purpose
Creates a path for the parent directory of a specified path. You can pass the same path variable for the parent path that you use for path. Therefore, you can call this function in the following two ways:
•err = FDirName(path, dir);
/* the parent path is returned in a second path variable */
•err = FDirName(path, path);
/* the parent path writes over the existing path */
Parameters
Name |
Type |
Description |
|
|
|
|
|
|
path |
Path |
Path whose parent path you want to |
|
|
determine. |
|
|
|
dir |
Path |
Parameter in which FDirName stores the |
|
|
parent path. |
|
|
|
Return Value
mgErr, which can contain the following errors:
mgArgErr |
A bad argument was passed to the function. Verify the path. |
Using External Code in LabVIEW |
6-60 |
www.ni.com |
Chapter 6 Function Descriptions
FDisposePath
MgErr FDisposePath(p);
Purpose
Disposes of a path.
Parameters
Name |
Type |
Description |
|
|
|
|
|
|
p |
Path |
Path you want to dispose of. |
|
|
|
Return Value
mgErr, which can contain the following errors:
mZoneErr |
Invalid path. |
© National Instruments Corporation |
6-61 |
Using External Code in LabVIEW |
Chapter 6 Function Descriptions
FDisposeRefNum
MgErr FDisposeRefNum(refNum);
Purpose
Disposes of the specified file refNum.
Parameters
Name |
Type |
Description |
|
|
|
|
|
|
refNum |
LVRefNum |
File refnum of which you want to dispose. |
|
|
|
Return Value
mgErr, which can contain the following errors:
mgArgErr |
File refnum is not valid. |
Using External Code in LabVIEW |
6-62 |
www.ni.com |