LEADTOOLS Raster Imaging C DLL Help > Function References > L_DeleteComment |
L_DeleteComment
#include "l_bitmap.h"
L_LTFIL_API L_INT L_DeleteComment(pszFile, uType, uFlags, pSaveOptions)
L_TCHAR* pszFile; |
/* character string containing the input file name */ |
L_UINT uType; |
/* type of comment */ |
L_UINT uFlags; |
/* flags */ |
pSAVEFILEOPTION pSaveOptions; |
/* pointer to optional extended save options */ |
Deletes a comment field from a file.
Parameter |
Description |
pszFile |
Character string containing the input file name. |
uType |
The type of comment. Refer to Types of File Comments. |
uFlags |
Reserved for future use. Pass 0. |
pSaveOptions |
Pointer to optional extended save options. Pass NULL to use the default save options. |
Returns
SUCCESS |
The comment was deleted. |
< 0 |
An error occurred. Refer to Return Codes. |
Comments
This function only applies to the TIF or EXIF file formats.
Some file formats can contain comments, and some cannot.Each file format has its own set of comment types. When you save a file, the comments, which LEADTOOLS maintains in a global array, are saved in the file. The index into the array (specified using a constant) determines the type of comment, as described in Types of File Comments.
Note: |
More options are available in the SAVEFILEOPTION structure. |
Required DLLs and Libraries
LTFIL For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Functions: |
|
Topics: |
|
|
|
|
For a list of functions that utilize the LOADFILEOPTION or SAVEFILEOPTION structures, refer to Functions Utilizing the LOADFILEOPTION or SAVEFILEOPTION structures. |
Example
Delete Comments from a file.
#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName L_INT DeleteCommentExample(L_VOID) { L_INT nRet; L_TCHAR szImageFileName[L_MAXPATH]; lstrcpy(szImageFileName, MAKE_IMAGE_PATH(TEXT("Test.jpg"))); nRet = L_ReadFileComment(szImageFileName, CMNT_IPTC_BYLINE, NULL, 0, NULL); if(nRet <= 0) return nRet; nRet = L_DeleteComment(szImageFileName, CMNT_IPTC_BYLINE, 0, NULL); if(nRet != SUCCESS) return nRet; nRet = L_ReadFileComment(szImageFileName, CMNT_IPTC_BYLINE, NULL, 0, NULL); if(nRet > 0) { OutputDebugString(TEXT("Error: Comment is still there!\n")); return nRet; } return SUCCESS; }