MrmPeekResourceIndexerMessages 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.]

View any messages generated by a resource indexer. 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 MrmPeekResourceIndexerMessages(
  _In_  MrmResourceIndexerHandle  indexer,
  _Out_ MrmResourceIndexerMessage **messages,
  _Out_ ULONG                     *numMsgs
);

Parameters

indexer [in]

Type: MrmResourceIndexerHandle

A handle identifying the resource indexer who messages you want to view.

messages [out]

Type: MrmResourceIndexerMessage**

A pointer to a pointer to an MrmResourceIndexerMessage. The function allocates an array of MrmResourceIndexerMessage and returns a pointer to that memory in messages. Do not free the pointer whose address you pass to messages.

numMsgs [out]

Type: ULONG*

The number of messages returned in messages.

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

Your app doesn't own the memory allocated and returned in messages, so don't free it.

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