L_DeleteMarker - Raster Imaging C API Help

L_DeleteMarker

#include "l_bitmap.h"

L_LTFIL_API L_INT L_DeleteMarker(hMarkers, uMarker, nCount)

L_VOID* hMarkers;

markers handle

L_UINT uMarker;

marker type to delete

L_INT nCount;

number of markers to delete

Deletes the specified number of markers of the specified type from the marker collection.

Parameter Description
hMarkers Handle to a collection of metadata markers. This handle is created by either the L_LoadMarkers function or the L_CreateMarkers function.
uMarker Value that represents the type of marker to delete. Recommended values are between 0xE0 and 0xFE. Other values are possible, but before using other values, study the JPEG specs to determine which markers are allowed.
nCount Number of markers to delete. This value is useful only if there is more than one marker of the specified type in the file. Possible values are:
  Value Meaning
  0 Delete all markers of type uMarker.
  > 0 Delete only the first nCount occurrences of type uMarker.
  Note: Negative values are not allowed.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The user can delete all the occurrences of uMarker, or the first few occurrences.

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.

Platforms

Win32, x64, Linux.

See Also

Functions:

L_LoadMarkers, L_CreateMarkers, L_InsertMarker, L_EnumMarkers, L_GetMarkerCount, L_GetMarker

Topics:

Raster Image Functions: Markers

 

Working with Markers

Example

This example will delete all occurrences of APP2 markers.

#define APP2 0xE2 
 
L_INT DeleteMarkerExample(HANDLE hMarkers) 
 
{ 
   L_INT nRet; 
   nRet = L_DeleteMarker(hMarkers, APP2, 0); 
   return nRet; 
} 

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help