L_GetMarkers

#include "l_bitmap.h"

L_LTFIL_API L_INT L_GetMarkers(phMarkers, uFlags)

L_VOID** phMarkers;

pointer to the markers handle

L_UINT uFlags;

flags that determine function behavior

Gets a copy of the last markers set with L_SetMarkers.

Parameter

Description

phMarkers

Pointer to a variable to be updated with a handle to a copy of the collection of markers last set with L_SetMarkers. This cannot be NULL.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Since you have a copy, anything you do with the handle will not modify the markers, which can be saved by calling a Save function. To modify the markers being saved, call L_SetMarkers.

When the marker collection handle is no longer needed, use L_FreeMarkers function to free it.

When calling L_GetMarkers, the phMarkers parameter cannot be NULL. However, if no markers have been set using L_SetMarkers, the phMarkers parameter will be updated with NULL when the function returns.

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_SetMarkers, L_FreeMarkers

Topics:

Raster Image Functions: Markers

 

Working with Markers

Example

This example tells you whether you have set any markers or not

L_INT GetMarkersExample(L_VOID) 
{ 
   L_INT nRet; 
   HANDLE hMarkers; 
 
   if((nRet = L_GetMarkers(&hMarkers, 0)) != SUCCESS) 
   { 
      MessageBox(NULL, TEXT("Error calling L_GetMarkers!"), TEXT("ERROR"), MB_OK); 
      return nRet; 
   } 
   else 
   { 
      if(hMarkers) 
      { 
         MessageBox(NULL, TEXT("You have set markers!"), TEXT("Info"), MB_OK); 
         L_FreeMarkers(hMarkers); 
      } 
      else 
         MessageBox(NULL, TEXT("You have not set any markers!"), TEXT("Info"), MB_OK); 
   } 
    
   return SUCCESS; 
} 

Help Version 20.0.2018.1.19
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help