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, EXIF, JPEG, JPEG2000 or FPX 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

LTFIL
File format DLLs

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

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

Help Version 19.0.2017.10.27

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help

Introduction

Version History

Getting Started

LEADTOOLS Raster Imaging Features

Redistributables/Files To Be Included With Your Application

Functions:	L_FileInfo, L_FileInfoMemory, L_GetComment, L_SetComment, L_WriteFileComment
Topics:	Raster Image Functions: Input and Output
	Loading and Saving Images
	For a list of functions that utilize the LOADFILEOPTION or SAVEFILEOPTION structures, refer to Functions Utilizing the LOADFILEOPTION or SAVEFILEOPTION structures.