HlinkTranslateURL function

[HlinkTranslateURL may be altered or unavailable in subsequent versions of the operating system or product.]

Note  The Microsoft ActiveX Hyperlink API is deprecated in Windows Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.

Appends a default protocol to a URL if it does not have one. The result is returned in ppwzTranslatedURL, and must be freed by the caller using the OLE allocator.

Syntax

HRESULT HlinkTranslateURL(
        LPCWSTR pwzURL,
        DWORD   grfFlags,
  _Out_ LPWSTR  *ppwzTranslatedURL
);

Parameters

• pwzURL
  The URL to be translated.

• grfFlags
  An HLTRANSLATEF enumeration value that defines whether or not to use the default prefix during translation.

• ppwzTranslatedURL [out]
  The translated URL.

Return value

If this function succeeds, it returns S_OK. If this function returns S_FALSE, this means the URL is unchanged, and pwzCompObjAlloc is untouched. Otherwise, it returns an HRESULT error code.

Requirements