L_DeleteComment

Summary

Deletes a comment field from a file.

Syntax

#include "l_bitmap.h"

L_LTFIL_API L_INT L_DeleteComment(pszFile, uType, uFlags, pSaveOptions)

Parameters

L_TCHAR* pszFile

Character string containing the input file name.

L_UINT uType

The type of comment. Refer to Types of File Comments.

L_UINT uFlags

Reserved for future use. Pass 0.

pSAVEFILEOPTION pSaveOptions

Pointer to optional extended save options. Pass NULL to use the default save options.

Returns

Value Meaning
SUCCESS The comment was deleted.
< 0 An error occurred. Refer to Return Codes.

Comments

This function only applies to the TIF, EXIF, JPEG, JPEG2000, FPX and PNG files.

Some file formats can contain comments, and some cannot. Each file format has its own set of comment types. See Types of File Comments for a list of the types of comments supported by each file format.

Note

More options are available in the SAVEFILEOPTION structure.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Delete Comments from a file.

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; 
} 

Help Version 22.0.2022.6.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.