In This Topic ▼

LAnnAutomation::GetAutoContainer

Summary

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

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetAutoContainer(pLContainer)

virtual L_INT LAnnAutomation::GetAutoContainer(phContainer)

Parameters

LAnnContainer * pLContainer

Pointer to an LAnnContainer object to be updated with the handle of the automation objects container. If the object does not have a container, the updated value is NULL.

pHANNOBJECT phContainer

Pointer to 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 LAnnAutomation::GetAutoContainer(phContainer), 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.

Before calling LAnnAutomation::GetAutoContainer(pLContainer), you must declare a class object of type LAnnContainer. Then, pass the address of the object in the pLContainer parameter. This function will update the variable with the handle of the annotation objects 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 is an example for LAnnAutomation::GetAutoContainer(phContainer):

L_INT LAnnAutomation_GetAutoContainerExample( ) 
{ 
   L_INT nRet; 
   LBase::LoadLibraries(LT_ALL_LEADLIB);//make sure all libraries are loaded 
 
   LAnnAutomation MyAutomation;  
 
   //construct an automation object 
   HANNOBJECT hAnnContainer; 
   nRet = MyAutomation.GetAutoContainer(&hAnnContainer); 
   if ( nRet ==SUCCESS) 
 
   { 
 
      //…. do something here ….  
 
   } 
   
  return nRet; 
}