L_VecGetHyperlink

#include "lvkrn.h"

L_LVKRN_API L_INT L_VecGetHyperlink(pVector, pObject, uIndex, pTarget)

pVECTORHANDLE pVector;

/* pointer to vector handle */

const pVECTOROBJECT pObject;

/* pointer to a VECTOROBJECT structure */

L_UINT32 uIndex;

/* index in the target list */

pVECTORLINKDESC pTarget;

/* pointer to structure that will receive the hyperlink target information */

Gets information about one of the targets in the target list of a hyperlinked vector object.

Parameter

Description

pVector

Pointer to the vector handle.

pObject

Pointer to a VECTOROBJECT structure that contains the hyperlinked vector object for which to get the hyperlink target.

uIndex

Index in the target list.

pTarget

Pointer to a VECTORLINKDESC structure to be updated with the hyperlink target information.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function returns an error if the object was 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_VecGetHyperlinkCount, L_VecGotoHyperlink

Topics:

Hyperlink Object

 

Hyperlink Objects

Example

L_INT VecGetHyperlinkExample(
   pVECTORHANDLE pVector,
   pVECTOROBJECT pVecObj)
{
   L_INT          nRet;
   L_UINT         i;
   L_UINT         uCount;
   VECTORLINKDESC Link;

   nRet   = SUCCESS;
   uCount = L_VecGetHyperlinkCount( pVector, pVecObj );

   for( i = 0 ; i < uCount && SUCCESS == nRet ; i++ )
   {
      nRet = L_VecGetHyperlink ( pVector, pVecObj, i, &Link );
      if( SUCCESS == nRet && TRUE == Link.bObject && VECTOR_RECTANGLE == Link.tar.vectorobject.target.nType )
      {
         Link.bObject = FALSE;

         lstrcpy( Link.tar.fileobject.target.szPath, MAKE_IMAGE_PATH(TEXT("cannon.jpg")));
         Link.tar.fileobject.hwndParent = NULL;

         nRet = L_VecSetHyperlink ( pVector, pVecObj, i, &Link );
      }
   }

   return nRet;
}