Edit

Share via

MrmLoadStringOrEmbeddedResourceByIndex function (mrm.h)

  • Article

Load a resource of any MrmType by the specified index.

Syntax

HRESULT MrmLoadStringOrEmbeddedResourceByIndex(
  MrmManagerHandle resourceManager,
  MrmContextHandle resourceContext,
  MrmMapHandle     resourceMap,
  UINT32           index,
  MrmType          *resourceType,
  PWSTR            *resourceName,
  PWSTR            *resourceString,
  MrmResourceData  *data
);

Parameters

resourceManager

The ResourceManager.

resourceContext

The ResourceContext. Uses the default context if null.

resourceMap

The ResourceMap. Uses root if null.

index

The index of the desired resource within the ResourceMap.

resourceType

The MrmType of the resource to be loaded.

resourceName

Contains the name of the loaded resource if the call was successful.

Resource name must be freed by calling MrmFreeResource.

resourceString

Contains the resource string if the call was successful and resourceType was either MrmType.String or MrmType.Path.

Resource data must be freed by calling MrmFreeResource.

data

Contains the resource data if the call was successful and resourceType was MrmType.Embedded.

Resource data must be freed by calling MrmFreeResource.

Return value

HRESULT that indicates the result of the operation.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 (with Windows App SDK 0.5 or later)
Header mrm.h

See also