LabWindows/CVI

Content Type
Programming Language
Current manual

DeleteFile

DeleteFile

int DeleteFile (char fileName[]);

Purpose

Deletes an existing file or a group of existing files.

Caution  The Windows SDK also contains a function with the same name. Include windows.h before including utility.h to ensure that there are no compilation errors as a result of this naming conflict. Define the SDK_CONFLICT_PRIORITYSDK_CONFLICT_PRIORITY macro to force LabWindows/CVI to use the Windows SDK implementation of this function.

Parameters

Input
Name Type Description
fileName char [] The pathname of the file to delete.

fileName can contain wildcard characters ? and *, in which case DeleteFile deletes all matching files.

If you specify an empty string "", DeleteFile deletes the file found by the most recent call to GetFirstFile or GetNextFile.

Note    The pattern matching behavior of * is greedy and matches all subsequent characters in the pattern except the file extension. The * wildcard is useful only at the end of a filename or file extension; for example, foo*.doc*. If you use this wildcard in other locations, it matches the rest of the string; for example, *foo.txt matches bar.txt.

Return Value

Name Type Description
result int Result of the delete operation.

Code Description
0 Success.
-1 File not found or directory in path not found.
-3 General I/O error occurred.
-4 Insufficient memory to complete operation.
-5 Invalid path; for example, c:filename.
-6 Access denied.
-7 Specified path is a directory, not a file.

Additional Information

Library: Utility Library

Include file: utility.h

LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later

Was this information helpful?