ITextRange2::GetURL method (tom.h)

Article
02/22/2024

Returns the URL text associated with a range.

Syntax

HRESULT GetURL(
  [out, retval] BSTR *pbstr
);

Parameters

[out, retval] pbstr

Type: BSTR*

The URL text associated with the range.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code	Description
E_INVALIDARG	Invalid argument.
E_OUTOFMEMORY	Insufficient memory.

Remarks

This method sets the start and end positions of the range to that of the whole hyperlink, including the friendly name, if any.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll