MrmPeekResourceIndexerMessages function

Retrieves diagnostic messages generated by a resource indexer. These may help in debugging problems with the indexer, although not all errors are reported.

Syntax

HRESULT HRESULT MrmPeekResourceIndexerMessages(
  _In_  MrmResourceIndexerHandle  indexer,
  _Out_ MrmResourceIndexerMessage **messages,
  _Out_ ULONG                     *numMsgs
);

Parameters

indexer [in]

Type: MrmResourceIndexerHandle

A handle identifying the resource indexer to retrieve messages from. This handle is returned via a call to MrmCreateResourceIndexer or one of the related MrmCreateResourceIndexer...* functions.

messages [out]

Type: MrmResourceIndexerMessage**

The address of an MrmResourceIndexerMessage pointer. On successful return, contains an array of MrmResourceIndexerMessage structures.

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

Do not free the memory pointed to by *messages as it is owned by the indexer. The memory will automatically be freed when calling MrmDestroyIndexerAndMessages after you have finished using the indexer.

Requirements

See also

MrmResourceIndexerMessage

Package resource indexing (PRI) APIs and custom build systems