MrmIndexFile 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. Takes an explicit (but optional) list of resource qualifiers. 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 MrmIndexFile(
  _In_     MrmResourceIndexerHandle indexer,
  _In_     PCWSTR                   resourceUri,
  _In_     PCWSTR                   filePath,
  _In_opt_ PCWSTR                   qualifiers
);

Parameters

indexer [in]

Type: MrmResourceIndexerHandle

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

resourceUri [in]

Type: PCWSTR

The resource URI to assign to the resource. The path will be used as the resource map subtree name for this resource when you later generate a PRI file from this resource indexer.

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.

qualifiers [in, optional]

Type: PCWSTR

An optional list of resource qualifiers, for example L"language-en-US_scale-100_contrast-standard". An empty string or nullptr indicates a neutral resource. Resource qualifiers are not inferred from resourceUri nor from containerPath.

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

If you want to specify any resource qualifiers, then pass them in the qualifiers parameter. Resource qualifiers are not inferred from resourceUri nor from filePath.

The file name segment of resourceUri (not filePath) is used as the resource name.

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