LAnnRuler::LAnnRuler

#include "ltwrappr.h"

LAnnRuler::LAnnRuler(bCreate=TRUE)

LAnnRuler::LAnnRuler(hRuler)

L_BOOL bCreate;	/* flag that indicates whether to create the associated annotation object */
HANNOBJECT & hRuler;	/* handle of the associated annotation object */

Constructs and initializes the member variables of the LAnnRuler object.

Parameter	Description
bCreate	Flag that indicates whether to create the associated annotation object. Possible values are:
	Value	Meaning
	TRUE	Create the associated Annotation object, as well as the class object.
	FALSE	Create only the class object. Do not create the associated annotation object.
hRuler	Handle of the associated annotation object.

Returns

None

Comments

LAnnRuler::LAnnRuler(bCreate) is a constructor for the LAnnRuler class. If bCreate is TRUE, the annotation object is created, as well as the class object.

LAnnRuler::LAnnRuler(hRuler) attaches the passed handle to the created class object. The passed handle must be a LEAD annotation object of type ANNOBJECT_RULER. The passed annotation object is invalidated.

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.

See Also

Functions:

LAnnRuler::~LAnnRuler, Class Members

Example

This is an example for LAnnRuler::LAnnRuler(bCreate):

L_INT LAnnRuler_LAnnRulerFirstExample()
{
   // this will call the constructor and destructor when it is out of scope
   LAnnRuler  LeadARuler(TRUE) ;
   //...
	return SUCCESS;
}
//This is an example for LAnnRuler::LAnnRuler(hRuler):
L_INT LAnnRuler_LAnnRulerSecondExample(HANNOBJECT& hRuler)
{
   // this will call the constructor and destructor when it is out of scope
   LAnnRuler  LeadARuler(hRuler) ;
   //...
	return SUCCESS;
}