Edit

Share via

IXpsOMVisual::GetIsHyperlinkTarget method (xpsobjectmodel.h)

  • Article

Gets a value that indicates whether the visual is the target of a hyperlink.

Syntax

HRESULT GetIsHyperlinkTarget(
  [out, retval] BOOL *isHyperlink
);

Parameters

[out, retval] isHyperlink

The Boolean value that indicates whether the visual is the target of a hyperlink.

Value Meaning
TRUE
 The visual is the target of a hyperlink.
FALSE
 The visual is not the target of a hyperlink.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code Description
S_OK
 The method succeeded.
E_POINTER
 isHyperlink is NULL.

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header xpsobjectmodel.h

See also

IXpsOMVisual

XML Paper Specification

XPS Document Errors