IUrlAccessor2::GetDisplayUrl method (searchapi.h)

Article
02/22/2024

Gets the user-friendly path for the URL item.

Syntax

HRESULT GetDisplayUrl(
  [out] WCHAR [] wszDocUrl,
  [in]  DWORD    dwSize,
  [out] DWORD    *pdwLength
);

Parameters

[out] wszDocUrl

Type: WCHAR[]

Receives the display URL as a null-terminated Unicode string.

[in] dwSize

Type: DWORD

Size in TCHARs of wszDocUrl.

[out] pdwLength

Type: DWORD*

Receives a pointer to the number of TCHARs written to wszDocUrl, not including the terminating NULL.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Protocol handlers can reveal hierarchical or non-hierarchical stores. If the data store is organized hierarchically, users can scope their searches to a specified container object like a directory or folder.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	searchapi.h
Redistributable	Windows Desktop Search (WDS) 3.0

Share via