L_VecGotoHyperlink

#include "lvkrn.h"

L_INT EXT_FUNCTION L_VecGotoHyperlink(pVector, pObject, uIndex)

pVECTORHANDLE pVector;

/* pointer to the vector handle */

const pVECTOROBJECT pObject;

/* pointer to a structure */

L_UINT32 uIndex;

/* index to an item in the target list */

Activates the specified target from the target list of the hyperlinked vector object.

Parameter

Description

pVector

Pointer to the vector handle.

pObject

Pointer to a VECTOROBJECT structure that references the vector object for which to activate the hyperlink.

uIndex

Index to an item in the target list. The target specified by this index will be used and activated.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function fails if pObject is not a hyperlinked vector object.

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_VecAddHyperlink, L_VecSetHyperlink, L_VecGetHyperlink, L_VecGetHyperlinkCount

Topics:

Hyperlink Object

 

Hyperlink Objects

Example

L_INT JumpToLink( pVECTORHANDLE pVector, pVECTOROBJECT pVecObj )
{
   return L_VecGotoHyperlink ( pVector, pVecObj, 0 );
}