In This Topic ▼

L_AnnGetContainer

Summary

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

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetContainer(hObject, phContainer)

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

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 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) 
      _tprintf(_T("%s"), TEXT("Notice: Top-level object")); 
   else 
      _tprintf(_T("%s"), TEXT("Notice: Object in a sub-container")); 
 
   return SUCCESS; 
}