ImageGear for C and C++ on Windows v19.2 - Updated
IG_TWAIN_file_delete
API Reference Guide > TWAIN Component API Reference > TWAIN Component Functions Reference > Device File System Functions > IG_TWAIN_file_delete

This function deletes a file or directory on the device.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_TWAIN_file_delete(
        LPCSTR lpszFileName,
        AT_BOOL bRecursive
);

Arguments:

Name Type Description
lpszFileName LPCSTR The name of file to delete.
bRecursive AT_BOOL Specifies whether it is recursive deleting or not.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

Pathnames are not allowed, only the name of the file or directory to be deleted can be specified. Recursive deletion can be specified by setting the bRecursive to TRUE.

Use IG_TWAIN_source_open() to select the desired Data Source.