MrmIndexFileAutoQualifiers function

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Indexes a resource file belonging to a UWP app. Infers a list of resource qualifiers from the filePath parameter. For more info, and scenario-based walkthroughs of how to use these APIs, see Package resource indexing (PRI) APIs and custom build systems.

Syntax

HRESULT HRESULT MrmIndexFileAutoQualifiers(
  _In_ MrmResourceIndexerHandle indexer,
  _In_ PCWSTR                   filePath
);

Parameters

indexer [in]

Type: MrmResourceIndexerHandle

A handle identifying the resource indexer that will index the resource file.

filePath [in]

Type: PCWSTR

A relative path to a file containing a resource that you want to index. This path is relative to the project root of the UWP app for which you are generating PRI files. That project root is the value of projectRoot that you passed to MrmCreateResourceIndexer.

Return value

Type: HRESULT

S_OK if the function succeeded, otherwise some other value. Use the SUCCEEDED() or FAILED() macros (defined in winerror.h) to determine success or failure.

Remarks

The file name segment of filePath is used as the resource name; and resource qualifiers are derived from its path. For example, if you pass L"Images\de-DE\scale-100\background.png" to filePath then the resource indexer adds a resource named "background.png" with resource qualifiers "language-de-DE" and "scale-100".

L"Files" will be used as the resource map subtree name for this resource when you later generate a PRI file from this resource indexer.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1803 [desktop apps only]
Minimum supported server	Windows Server [desktop apps only]
Header	MrmResourceIndexer.h
Library	Mrmsupport.lib
DLL	Mrmsupport.dll

See also

Package resource indexing (PRI) APIs and custom build systems