EvtArchiveExportedLog function (winevt.h)

Article
02/22/2024

Adds localized strings to the events in the specified log file.

Syntax

BOOL EvtArchiveExportedLog(
  [in] EVT_HANDLE Session,
  [in] LPCWSTR    LogFilePath,
  [in] LCID       Locale,
  [in] DWORD      Flags
);

Parameters

[in] Session

A remote session handle that the EvtOpenSession function returns. Set to NULL for local channels.

[in] LogFilePath

The full path to the exported log file that contains the events to localize.

[in] Locale

The locale to use to localize the strings that the service adds to the events in the log file. If zero, the function uses the calling thread's locale. If the provider's resources does not contain the locale, the string is empty.

[in] Flags

Reserved. Must be zero.

Return value

Return code/value	Description
TRUE	The function succeeded.
FALSE	The function failed. Use the GetLastError function to get the error code.

Remarks

To consume an event from an exported log file, the provider needs to be available to provide the resources (message strings) for the event. You would call this function to include the localized resources with the event, so that you can consume the event when the provider is not available.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	winevt.h
Library	Wevtapi.lib
DLL	Wevtapi.dll