- •Important Information
- •Warranty
- •Copyright
- •Trademarks
- •Organization of This Manual
- •Conventions Used in This Manual
- •Related Documentation
- •Customer Communication
- •Classes of External Code
- •Introduction
- •Supported Languages
- •Macintosh
- •Microsoft Windows 3.1
- •Microsoft Windows 95 and Windows NT
- •Solaris
- •Steps for Creating a CIN
- •1. Place the CIN on a Block Diagram
- •2. Add Input and Output Terminals to the CIN
- •Input-Output Terminals
- •Output-Only Terminals
- •3. Wire the Inputs and Outputs to the CIN
- •4. Create .c File
- •Special Macintosh Considerations
- •5. Compile the CIN Source Code
- •Macintosh
- •THINK C for 68K (Versions 5-7)
- •Symantec C++ 8.0 for Power Macintosh
- •Metrowerks CodeWarrior for 68K
- •Metrowerks CodeWarrior for Power Macintosh
- •Microsoft Windows 3.x
- •Watcom C Compiler
- •Microsoft Windows 95 and Windows NT
- •Microsoft SDK C/C++ Compiler
- •Visual C++ for Windows 95 or Windows NT
- •Solaris 1.x
- •Solaris 2.x
- •6. Load the CIN Object Code
- •LabVIEW Manager Routines
- •Online Reference
- •Pointers as Parameters
- •Debugging External Code
- •DbgPrintf
- •Debugging CINs Under Windows 95 and Windows NT
- •Debugging CINs Under Sun or Solaris
- •Debugging CINs Under HP-UX
- •Introduction
- •CIN .c File
- •How LabVIEW Passes Fixed Sized Data to CINs
- •Scalar Numerics
- •Scalar Booleans
- •Refnums
- •Clusters of Scalars
- •Return Value for CIN Routines
- •Examples with Scalars
- •1. Place the CIN on the Block Diagram
- •2. Add Two Input and Output Terminals to the CIN
- •3. Wire the Inputs and Outputs to the CIN
- •4. Create the CIN Source Code
- •5. Compile the CIN Source Code
- •Macintosh
- •THINK C for 68K and Symantec C++
- •Microsoft Windows 3.x
- •Watcom C Compiler
- •Microsoft Windows 95 and Windows NT
- •Microsoft SDK Compiler
- •Microsoft Visual C++ Compiler
- •Solaris 1.x, Solaris 2.x, and HP-UX
- •6. Load the CIN Object Code
- •Comparing Two Numbers, Producing a Boolean Scalar
- •How LabVIEW Passes Variably Sized Data to CINs
- •Alignment Considerations
- •Arrays and Strings
- •Paths (Path)
- •Clusters Containing Variably Sized Data
- •Resizing Arrays and Strings
- •SetCINArraySize
- •NumericArrayResize
- •Examples with Variably Sized Data
- •Concatenating Two Strings
- •Working with Clusters
- •CIN Routines
- •Data Spaces and Code Resources
- •CIN Routines: The Basic Case
- •Loading a VI
- •Unloading a VI
- •Loading a New Resource into the CIN
- •Compiling a VI
- •Running a VI
- •Saving a VI
- •Aborting a VI
- •Multiple References to the Same CIN
- •Reentrancy
- •Code Globals and CIN Data Space Globals
- •Examples
- •Using Code Globals
- •Using CIN Data Space Globals
- •Calling a Windows 3.1 Dynamic Link Library
- •2. Get the address of the desired function
- •3. Describe the function
- •4. Call the function
- •Calling a 16-Bit DLL
- •1. Load the DLL
- •Example: A CIN that Displays a Dialog Box
- •The Block Diagram
- •The CIN Code
- •Compiling the CIN
- •Optimization
- •Introduction
- •Creating Shared External Subroutines
- •External Subroutine
- •Macintosh
- •THINK C Compiler and CodeWarrior 68K Compiler
- •MPW Compiler
- •Solaris 1.x, Solaris 2.x, and HP-UX
- •Calling Code
- •Macintosh
- •THINK C Compiler
- •CodeWarrior 68K Compiler
- •MPW Compiler
- •Solaris 1.x, Solaris 2.x, and HP-UX
- •Simple Example
- •External Subroutine Example
- •Compiling the External Subroutine
- •Macintosh
- •THINK C Compiler and CodeWarrior 68K Compiler
- •MPW Compiler
- •Microsoft Windows 3.1
- •Watcom C Compiler
- •Microsoft Windows 95 and Windows NT
- •Solaris 1.x, Solaris 2.x, and HP-UX
- •Calling Code
- •Compiling the Calling Code
- •Macintosh
- •THINK C Compiler
- •CodeWarrior 68K Compiler
- •MPW Compiler
- •Microsoft Windows 3.1
- •Watcom C Compiler
- •Microsoft Windows 95 and Windows NT
- •Solaris 1.x, Solaris 2.x, and HP-UX
- •Introduction
- •Basic Data Types
- •Scalar Data Types
- •Booleans
- •Numerics
- •Complex Numbers
- •char Data Type
- •Dynamic Data Types
- •Arrays
- •Strings
- •C-Style Strings (CStr)
- •Pascal-Style Strings (PStr)
- •LabVIEW Strings (LStr)
- •Concatenated Pascal String (CPStr)
- •Paths (Path)
- •Memory-Related Types
- •Constants
- •Memory Manager
- •Memory Allocation
- •Static Memory Allocation
- •Dynamic Memory Allocation: Pointers and Handles
- •Memory Zones
- •Using Pointers and Handles
- •Simple Example
- •Reference to the Memory Manager
- •Memory Manager Data Structures
- •File Manager
- •Introduction
- •Identifying Files and Directories
- •Path Specifications
- •Conventional Path Specifications
- •Empty Path Specifications
- •LabVIEW Path Specification
- •File Descriptors
- •File Refnums
- •Support Manager
- •Allocating and Releasing Handles
- •Allocating and Releasing Pointers
- •Manipulating Properties of Handles
- •AZHLock
- •AZHPurge
- •AZHNoPurge
- •AZHUnlock
- •Memory Utilities
- •ClearMem
- •MoveBlock
- •SwapBlock
- •Handle and Pointer Verification
- •Memory Zone Utilities
- •File Manager Data Structures
- •File/Directory Information Record
- •File Type Record
- •Path Data Type
- •Permissions
- •Volume Information Record
- •File Manager Functions
- •Performing Basic File Operations
- •FCreate
- •FCreateAlways
- •FMClose
- •FMOpen
- •FMRead
- •FMWrite
- •Positioning the Current Position Mark
- •FMSeek
- •FMTell
- •Positioning the End-Of-File Mark
- •FGetEOF
- •FSetEOF
- •Flushing File Data to Disk
- •FFlush
- •FExists
- •FGetAccessRights
- •FGetInfo
- •FGetVolInfo
- •FSetAccessRights
- •FSetInfo
- •Getting Default Access Rights Information
- •FGetDefGroup
- •FListDir
- •FNewDir
- •Copying Files
- •FCopy
- •Moving and Deleting Files and Directories
- •FMove
- •FRemove
- •Locking a File Range
- •FLockOrUnlockRange
- •Matching Filenames with Patterns
- •FStrFitsPat
- •Creating Paths
- •FAddPath
- •FAppendName
- •FAppPath
- •FEmptyPath
- •FMakePath
- •FNotAPath
- •FRelPath
- •Disposing Paths
- •FDisposePath
- •Duplicating Paths
- •FPathCpy
- •FPathToPath
- •Extracting Information from a Path
- •FDepth
- •FDirName
- •FName
- •FNamePtr
- •FVolName
- •FArrToPath
- •FFlattenPath
- •FPathToArr
- •FPathToAZString
- •FPathToDSString
- •FStringToPath
- •FTextToPath
- •FUnFlattenPath
- •Comparing Paths
- •FIsAPath
- •FIsAPathOrNotAPath
- •FIsEmptyPath
- •FPathCmp
- •Determining a Path Type
- •FGetPathType
- •FIsAPathOfType
- •FSetPathType
- •Manipulating File Refnums
- •FDisposeRefNum
- •FIsARefNum
- •FNewRefNum
- •FRefNumToFD
- •FRefNumToPath
- •Byte Manipulation Operations
- •Mathematical Operations
- •For THINK C Users
- •RandomGen
- •String Manipulation
- •BlockCmp
- •CPStrCmp
- •CPStrIndex
- •CPStrInsert
- •CPStrRemove
- •CPStrReplace
- •CPStrSize
- •CToPStr
- •HexChar
- •IsAlpha
- •IsDigit
- •IsLower
- •IsUpper
- •LStrCmp
- •LToPStr
- •PPStrCaseCmp
- •PPStrCmp
- •PStrCaseCmp
- •PStrCat
- •PStrCmp
- •PStrCpy
- •PStrNCpy
- •PToCStr
- •PToLStr
- •StrCat
- •StrCmp
- •StrCpy
- •StrLen
- •StrNCaseCmp
- •StrNCmp
- •StrNCpy
- •ToLower
- •ToUpper
- •Utility Functions
- •BinSearch
- •QSort
- •Time Functions
- •ASCIITime
- •DateCString
- •DateToSecs
- •MilliSecs
- •SecsToDate
- •TimeCString
- •TimeInSecs
- •Microsoft Windows 3.1, Windows 95, and Windows NT
- •Macintosh
- •How do I debug my CIN?
- •Can LabVIEW be used to call a DLL in Windows?
- •Glossary
- •Index
|
Chapter 7 File Manager Functions |
|
Error |
Description |
|
mgArgErr |
Not a valid file descriptor or size < 0. |
|
fDiskFull |
Disk is full. |
|
fNoPerm |
Access denied (file exists or something is locked/protected). |
|
fIOErr |
Unspecified I/O error occurred. |
|
|
|
|
Flushing File Data to Disk
FFlush
syntax |
MgErr |
FFlush(fd); |
FFlush writes any buffered data for the specified file out to the disk.
|
Parameter |
Type |
Description |
|
fd |
File |
File descriptor associated with the file. |
returns |
MgErr, which can contain the errors in the following list. |
||
|
Error |
Description |
|
|
mgArgErr |
Not a valid file descriptor. |
|
|
fIOErr |
Unspecified I/O error occurred. |
|
|
|
|
|
Determining File, Directory, and Volume Information
FExists
syntax |
int32 |
FExists(path); |
FExists returns information about the specified file or directory. It returns less information than FGetInfo, but it is much quicker on many platforms.
Parameter |
Type |
Description |
path |
Path |
Path of the file or directory about which you want |
|
|
information. |
returns |
int32, which is one of the following values. |
|
Error |
Description |
|
kFIsFile |
Specified item is a file. |
|
National Instruments Corporation |
7-13 |
LabVIEW Code Interface Reference Manual |
Chapter 7 File Manager Functions
|
kFIsFolder |
Specified item is a directory or folder. |
||
|
kFNotExist |
Specified item does not exist. |
||
|
|
|
|
|
FGetAccessRights |
|
|
|
|
syntax |
MgErr |
FGetAccessRights(path, owner, group, |
||
|
|
permPtr); |
||
|
FGetAccessRights returns access rights information about the specified file or |
|||
|
directory. |
|
|
|
|
Parameter |
Type |
Description |
|
|
path |
Path |
Path of the file or directory about which you want |
|
|
|
|
access rights information. |
|
|
owner |
PStr |
Address at which FGetAccessRights stores the |
|
|
|
|
owner of the file or directory. |
|
|
group |
PStr |
Address at which FGetAccessRights stores the |
|
|
|
|
group of the file or directory. |
|
|
permPtr |
int32 * |
Address at which FGetAccessRights stores the |
|
|
|
|
permissions of the file or directory. See the File |
|
|
|
|
Manager Data Structures section of this chapter for |
|
|
|
|
a description of permissions. |
|
|
|
|
See the Pointers as Parameters section of |
|
|
|
|
Chapter 1, CIN Overview, for more information |
|
|
|
|
about using this parameter. |
|
returns |
MgErr, which can contain the errors in the following list. |
|||
|
Error |
Description |
|
|
|
mgArgErr |
A bad argument was passed to the function. Verify path. |
||
|
fNotFound |
File not found. |
|
|
|
fIOErr |
Unspecified I/O error occurred. |
||
|
|
|
|
|
FGetInfo |
|
|
|
|
syntax |
MgErr |
FGetInfo(path, infop); |
||
FGetInfo returns information about the specified file or directory.
Parameter |
Type |
Description |
LabVIEW Code Interface Reference Manual |
7-14 |
National Instruments Corporation |
|
|
|
Chapter 7 File Manager Functions |
|
|
path |
Path |
Path of the file or directory about which you want |
|
|
|
|
information. |
|
|
infop |
FInfoPtr |
Address where FGetInfo stores information |
|
|
|
|
about the file or directory. If an error occurs, the |
|
|
|
|
information is undefined. See the File Manager |
|
|
|
|
Data Structures section of this chapter for a |
|
|
|
|
description of the FInfoPtr data type. |
|
|
|
|
See also the Pointers as Parameters section of |
|
|
|
|
Chapter 1, CIN Overview, for more information |
|
|
|
|
about using this parameter. |
|
returns |
MgErr, which can contain the errors in the following list. |
|||
|
Error |
Description |
|
|
|
mgArgErr |
A bad argument was passed to the function. Verify path. |
||
|
fNotFound |
File not found. |
|
|
|
fIOErr |
Unspecified I/O error occurred. |
||
|
|
|
|
|
FGetVolInfo
syntax MgErr FGetVolInfo(path, vinfo);
FGetVolInfo gets a path specification and information for the volume containing the specified file or directory.
Parameter |
Type |
Description |
path |
Path |
Path of a file or directory contained on the volume |
|
|
from which you want to get information. This path |
|
|
is overwritten with a path specifying the volume |
|
|
containing the specified file or directory. If an error |
|
|
occurs, this path is undefined. |
vinfo |
VInfoRec * |
Address at which FGetVolInfo stores the |
|
|
information about the volume. If an error occurs, the |
|
|
information is undefined. See the File Manager |
|
|
Data Structures section of this chapter for a |
|
|
description of the VInfoRec data type. |
|
|
See the Pointers as Parameters section of |
|
|
Chapter 1, CIN Overview, for more information |
|
|
about using this parameter. |
returns |
MgErr, which can contain the errors in the following list. |
|
National Instruments Corporation |
7-15 |
LabVIEW Code Interface Reference Manual |