L_AnnGetContainer

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetContainer(hObject, phContainer)

Gets the handle of the container of the specified annotation object.

Parameters

HANNOBJECT hObject

Handle to the annotation object.

pHANNOBJECT phContainer

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

Returns

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

Comments

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

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

This example compares the immediate container to the root container.

L_INT AnnGetContainerExample(HANNOBJECT hAnnObject) 
{ 
   L_INT nRet; 
   HANNOBJECT ThisContainer;  /* Container for this object */ 
   HANNOBJECT TopContainer;   /* Root container for the whole window */ 
 
   /* Get both the immediate container and the root container */ 
   nRet = L_AnnGetContainer(hAnnObject, &ThisContainer); 
   if(nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnGetTopContainer(hAnnObject, &TopContainer); 
   if(nRet != SUCCESS) 
      return nRet; 
   /* Compare the container handles */ 
   if (ThisContainer == TopContainer) 
      MessageBox (NULL, TEXT("Top-level object"), TEXT("Notice"), MB_OK); 
   else 
      MessageBox (NULL, TEXT("Object in a sub-container"), TEXT("Notice"), MB_OK); 
   return SUCCESS; 
} 

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

LEADTOOLS Raster Imaging C API Help