In This Topic ▼

L_AnnGetAutoContainer

Summary

Gets the handle of the container for the automation object. The automation object is used to implement default properties.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetAutoContainer(hObject, phContainer)

Parameters

HANNOBJECT hObject

Handle to an annotation automation object.

pHANNOBJECT phContainer

Address of the HANNOBJECT variable to be updated with the handle of the automation objects 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

The automation object is associated with a root container but is not in the container.

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 gets the automation object’s container and assigns it to a global variable.

L_INT AnnGetAutoContainerExample(HANNOBJECT hAutoObject, HANNOBJECT hContainer /* Container annotation object */) 
{ 
   HANNOBJECT  ThisContainer; /* Automation object's container */ 
   L_INT       nRet;          /* Return value */ 
 
   /* Get the automation object's container */ 
   nRet = L_AnnGetAutoContainer(hAutoObject, &ThisContainer); 
   if (nRet != SUCCESS) 
   { 
      _tprintf(_T("%s"), TEXT("Error: Automation object has no container.")); 
      return nRet; 
   } 
 
   /* Assign the object to the global Container variable */ 
   hContainer = ThisContainer; 
 
   return SUCCESS; 
}