Collapse All Expand All

LVectorObject::AddHyperlink

#include "ltwrappr.h"

L_INT LVectorObject::AddHyperlink(pTarget)

pVECTORLINKDESC pTarget;

/* target information */

Adds a new item to the target list for the specified hyperlinked vector object.

Parameter	Description
pTarget	Pointer to a VECTORLINKDESC that determines how the toolkit will handle the hyperlink.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Hyperlinked vector objects cause some action to take place when the end-user clicks on them. Each of these objects maintains a list of targets. That is, clicking on a hyperlinked vector object may cause several different things to occur. Depending on the target(s) and how the user specifies handling the target(s), the vector toolkit will act in response to the end-user's actions on that target.

A hyperlink must be added to a vector object using this function before it can be changed using the LVectorObject::SetHyperlink function.

Required DLLs and Libraries

LVKRN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:	LVectorObject::SetHyperlink, LVectorObject::GetHyperlink, LVectorObject::GetHyperlinkCount, LVectorObject::GotoHyperlink
Topics:	Vector Images: Hyperlink Object
	Hyperlink Objects

Example

L_INT LVectorObject__AddHyperlinkExample( LVectorObject *pVecObj, pVECTOROBJECT pTarget, L_INT & nCount)
{
   L_INT          nRet;
   VECTORLINKDESC Link;
   Link.bObject = TRUE; 
   Link.tar.vectorobject.target = *pTarget; 
   Link.tar.vectorobject.handling = VECTORLINKHANDLING_CURRENTWINDOW; 
   nRet = pVecObj->AddHyperlink( &Link );
   if( SUCCESS != nRet ) 
   {
      return nRet;
   }
   nCount = pVecObj->GetHyperlinkCount( );
   return SUCCESS;
}