Collapse All Expand All

LAnnRTF::LAnnRTF

#include "ltwrappr.h"

LAnnRTF::LAnnRTF(bCreate=TRUE)

LAnnRTF::LAnnRTF(hRTF)

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

Constructs and initializes the member variables of the LAnnRTF object.

Parameter	Description
hRTF	Handle of the associated annotation object.
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.

Returns

None.

Comments

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

LAnnRTF::LAnnRTF(hNote) attaches the passed handle to the created class object. The passed handle must be a LEAD annotation object of type LAnnRTF. 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:

LAnnRTF::~LAnnRTF, Class Members

Example

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

L_INT LAnnRTF_LAnnRTFFirstExample()
{
        // this will call the constructor and destructor when it is out of scope
        LAnnRTF  LeadARTF(TRUE) ;
        //...
        return SUCCESS;
}
//This is an example for LAnnRTF::LAnnRTF(hRTF):
L_INT LAnnRTF_LAnnRTFSecondExample(HANNOBJECT& hRTF)
{
        // this will call the constructor and destructor when it is out of scope
        LAnnRTF  LeadAFTR(hRTF) ;
   //...
        return SUCCESS;
}