MrmDumpPriFileInMemory 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.]
Dumps a PRI file (which is binary) to its XML equivalent (as in-memory data), in order to make it more easily readable. The function allocates memory and returns a pointer to that memory in outputXmlData. Call MrmFreeMemory with the same pointer to free that memory. 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 MrmDumpPriFileInMemory(
_In_ PCWSTR indexFileName,
_In_opt_ PCWSTR schemaPriFile,
_In_ MrmDumpType dumpType,
_Out_ BYTE **outputXmlData,
_Out_ ULONG *outputXmlSize
);
Parameters
-
indexFileName [in]
-
Type: PCWSTR
A full file path to a PRI file. This is the PRI file that will be dumped to XML.
-
schemaPriFile [in, optional]
-
Type: PCWSTR
An optional full file path to a schema file (or to a PRI file representing a schema; see Remarks).
-
dumpType [in]
-
Type: MrmDumpType
Specifies how detailed the XML dump should be, or whether a schema should be dumped.
-
outputXmlData [out]
-
Type: BYTE**
The address of a pointer to BYTE. The function allocates memory and returns a pointer to that memory in outputXmlData. Call MrmFreeMemory with your pointer to BYTE to free that memory.
-
outputXmlSize [out]
-
Type: ULONG*
The address of a ULONG. In outputXmlSize, the function returns the size of the allocated memory pointed to by outputXmlData.
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
A schema-free resource pack is one that was created with the MrmPackagingOptionsOmitSchemaFromResourcePacks argument passed to MrmCreateResourceFile or MrmCreateResourceFileInMemory (or with the omitSchemaFromResourcePacks switch in the PRI config file). To dump a schema-free resource pack, pass the path to your main package PRI data as the argument for the schemaPriFile parameter.
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
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for