Edit

IUrlAccessor::GetFileName method (searchapi.h)

  • Article

Retrieves the file name of the item, which the filter host uses for indexing. If the item does not exist in a file system and the IUrlAccessor::BindToStream method is implemented, this method returns the shell's System.ParsingPath property for the item.

Syntax

HRESULT GetFileName(
  [out] WCHAR [] wszFileName,
  [in]  DWORD    dwSize,
  [out] DWORD    *pdwLength
);

Parameters

[out] wszFileName

Type: WCHAR[]

Receives the file name as a null-terminated Unicode string.

[in] dwSize

Type: DWORD

Size in TCHARs of wszFileName, not including the terminating NULL.

[out] pdwLength

Type: DWORD*

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

Return value

Type: HRESULT

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

Remarks

If this method is implemented, the filter host uses the file name to determine the correct IFilter to use to parse the content of the stream returned by IUrlAccessor::BindToStream.

Requirements

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