L_VecAddHyperlink

#include "lvkrn.h"

L_LVKRN_API L_INT L_VecAddHyperlink(pVector, pObject, pTarget)

pVECTORHANDLE pVector;	/* pointer to vector handle */
pVECTOROBJECT pObject;	/* pointer to vector object */
pVECTORLINKDESC pTarget;	/* target information */

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

Parameter	Description
pVector	Pointer to the vector handle.
pObject	Pointer to a VECTOROBJECT structure that references a vector object. The target list of this hyperlinked vector object will be updated with the new target.
pTarget	Pointer to a VECTORLINKDESC structure 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 L_VecSetHyperlink 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:	L_VecSetHyperlink, L_VecGetHyperlink, L_VecGetHyperlinkCount, L_VecGotoHyperlink
Topics:	Hyperlink Object
	Hyperlink Objects

Example

L_INT VecAddHyperlinkExample(
   pVECTORHANDLE pVector,
   pVECTOROBJECT pVecObj,
   pVECTOROBJECT pTarget)
{
   L_INT          nRet;
   VECTORLINKDESC Link;

   ZeroMemory(&Link, sizeof(VECTORLINKDESC));
   Link.bObject = TRUE;

   Link.tar.vectorobject.target     = *pTarget;
   Link.tar.vectorobject.handling   = VECTORLINKHANDLING_CURRENTWINDOW;

   nRet = L_VecAddHyperlink ( pVector, pVecObj, &Link );
   if( nRet != SUCCESS)
      return nRet;

   nRet = L_VecGetHyperlinkCount ( pVector, pVecObj );
   if (nRet == 0)
      return FAILURE;

   return SUCCESS;
}