The BackupEventLog method saves the specified event log to a backup file. If a backup file with the same name exists, the method fails.
This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see
Calling a Method.
Syntax
uint32 BackupEventlog(
[in] string ArchiveFileName
);
Parameters
- ArchiveFileName [in]
-
Path and file name of the backup file to be created.
Note If the ArchiveFileName comes from a source that you do not know or trust, then this parameter value should be verified before using it in a call to BackupEventlog.
Return Value
Returns one of the values listed in the following table or any other value to indicate an error.
| Return code | Description |
|---|
- 0
| Success
|
- 8
| Privilege missing
|
- 21
| Invalid parameter
|
- 80
| Archive file name already exists. This value is returned starting with Windows Vista.
Windows Server 2003, Windows XP, Windows 2000, and Windows NT 4.0: The return code indicating that the archive file name already exists is 183.
|
Examples
For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.
For C++ code examples, see WMI C++ Application Examples.
Requirements
| Minimum supported client | Windows 2000 Professional |
|---|
| Minimum supported server | Windows 2000 Server |
|---|
| MOF | Ntevt.mof |
|---|
| DLL | Ntevt.dll |
|---|
| Namespace | \root\cimv2 |
|---|
See Also
- Operating System Classes
- Win32_NTEventlogFile
Send comments about this topic to Microsoft
Build date: 11/3/2009