MrmIndexString function
Adds a string resource to a Resource Indexer. Note that it is the resource name that is indexed, not the string. In other words, this function does not search the string looking for things to index.
Syntax
HRESULT HRESULT MrmIndexString(
_In_ MrmResourceIndexerHandle indexer,
_In_ PCWSTR resourceUri,
_In_ PCWSTR resourceString,
_In_opt_ PCWSTR qualifiers
);
Parameters
-
indexer [in]
-
Type: MrmResourceIndexerHandle
A handle identifying the resource indexer to add the resource to. This handle is returned via a call to MrmCreateResourceIndexer or one of the related MrmCreateResourceIndexer...* functions.
-
resourceUri [in]
-
Type: PCWSTR
The URI (name) to assign to the resource. By convention, string resources are added to the
strings/path (for example,ms-resource:///strings/appName). See Resource names in MRM for more info. -
resourceString [in]
-
Type: PCWSTR
The string to add to the index.
-
qualifiers [in, optional]
-
Type: PCWSTR
An optional list of resource qualifiers for the resource, for example "language-en-US". Passing an empty string or NULL indicates a neutral resource that is applicable in any resource context. See Qualifiers in MRM for more info.
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.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 10, version 1803 [desktop apps only] |
| Minimum supported server |
Windows Server [desktop apps only] |
| Header |
|
| Library |
|
| DLL |
|
See also
Package resource indexing (PRI) APIs and custom build systems