Edit

Share via

IndexFilePath function (resourceindexer.h)

  • Article

Indexes a file path for file and folder naming conventions.

Syntax

HRESULT IndexFilePath(
  [in]  PVOID                    resourceIndexer,
  [in]  PCWSTR                   filePath,
  [out] PWSTR                    *ppResourceUri,
  [out] ULONG                    *pQualifierCount,
  [out] IndexedResourceQualifier **ppQualifiers
);

Parameters

[in] resourceIndexer

The resource indexer object that you created by calling the CreateResourceIndexer function.

[in] filePath

The path for the folder that you want to index. The path must be an absolute path with the drive letter specified. Long file paths are not supported.

[out] ppResourceUri

A uniform resource indicator (URI) that uses the ms-resource URI scheme and represents the named resource for the candidate, where the authority of the URI or the resource map is empty. For example, ms-resource:///Resources/String1 or ms-resource:///Files/images/logo.png.

[out] pQualifierCount

The number of indexed resource qualifiers that the list in the ppQualifiers parameter contains.

[out] ppQualifiers

A list of indexed resource qualifiers that declare the context under which the resources are appropriate.

Return value

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

Requirements

Requirement Value
Minimum supported client Windows 10 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header resourceindexer.h
Library Mrmsupport.lib
DLL Mrmsupport.dll

See also

CreateResourceIndexer

IndexedResourceQualifier