In This Topic ▼

L_AnnGetItem

Summary

Gets the handle to the first annotation object in the specified container.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetItem(hContainer, phItem)

Parameters

HANNOBJECT hContainer

Handle of the container object.

pHANNOBJECT phItem

Address of the HANNOBJECT variable to be updated with the objects handle. If the container does not have any objects, the updated value is NULL.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

You can use this function to see if a container is empty.

Before calling this function, you must declare a variable of data type HANNOBJECT. Then, pass the address of the variable in the phItem parameter. This function will update the variable with the handle of the first object in the container.

Required DLLs and Libraries

LTANN
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

This example deletes the object that is passed in, if it is an empty sub-container.

L_INT AnnGetItemExample(HANNOBJECT hObject) 
{ 
   L_INT       nRet; 
   L_UINT      ObjectType;       /* Type of annotation object */ 
   HANNOBJECT  hTestObject; 
   HANNOBJECT  hRootContainer;   /* Root container for the whole window */ 
 
   /* Get the root container */ 
   nRet = L_AnnGetTopContainer(hObject, &hRootContainer); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* Do nothing if this is the root container */ 
   if (hObject == hRootContainer) 
      return SUCCESS; 
 
   /* See if this is a container */ 
   nRet = L_AnnGetType(hObject, &ObjectType); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* Do nothing if it is not a container */ 
   if (ObjectType != ANNOBJECT_CONTAINER) 
      return SUCCESS; 
 
   /* See if there are any objects in the container */ 
   nRet = L_AnnGetItem(hObject, &hTestObject); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* If there are none, delete the container */ 
   if (hTestObject == NULL) 
   { 
      nRet = L_AnnDestroy(hObject, 0); 
      if (nRet != SUCCESS) 
         return nRet; 
 
      _tprintf(_T("%s"), TEXT("Notice: Deleted empty container.")); 
   } 
 
   return SUCCESS; 
}