LVectorObject::GetHyperlink

#include "ltwrappr.h"

L_INT LVectorObject::GetHyperlink(uIndex, pTarget)

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
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:	LVectorObject::AddHyperlink, LVectorObject::SetHyperlink, LVectorObject::GetHyperlinkCount, LVectorObject::GotoHyperlink
Topics:	Vector Images: Hyperlink Object
	Hyperlink Objects

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
L_INT LVectorObject__GetHyperlinkExample( LVectorObject *pVecObj ) 
{
   L_INT          nRet = SUCCESS;
   L_UINT         i;
   L_UINT         uCount;
   VECTORLINKDESC Link;
   uCount = pVecObj->GetHyperlinkCount( ); 
   for( i = 0 ; i < uCount && SUCCESS == nRet ; i++ ) 
   {
      nRet = pVecObj->GetHyperlink( i, &Link );
      if(nRet != SUCCESS)
         return nRet;
      if(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 = pVecObj->SetHyperlink( i, &Link ); 
         if(nRet != SUCCESS)
            return nRet;
      }
      else
         return FAILURE;
   }
   return SUCCESS;
}