SetupRemoveFileLogEntry function

[This function is available for use in the operating systems indicated in the Requirements section. It may be altered or unavailable in subsequent versions. SetupAPI should no longer be used for installing applications. Instead, use the Windows Installer for developing application installers. SetupAPI continues to be used for installing device drivers.]

The SetupRemoveFileLogEntry function removes an entry or section from a file log.

Syntax


BOOL SetupRemoveFileLogEntry(
  _In_ HSPFILELOG FileLogHandle,
  _In_ PCTSTR     LogSectionName,
  _In_ PCTSTR     TargetFileName
);

Parameters

FileLogHandle [in]

Handle to the file log as returned by SetupInitializeFileLog. The caller must not have passed SPFILELOG_QUERYONLY when the log file was initialized.

LogSectionName [in]

Pointer to a null-terminated string that specifies the name for a logical grouping of names within the log file. Required for non-system logs. Otherwise, LogSectionName may be NULL.

TargetFileName [in]

Pointer to a null-terminated string that specifies the name of the file as it exists on the target. This name should be in whatever format is meaningful to the caller. If NULL, the section specified by LogSectionName is removed. The main section cannot be removed.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Setupapi.h

Library

Setupapi.lib

DLL

Setupapi.dll

Unicode and ANSI names

SetupRemoveFileLogEntryW (Unicode) and SetupRemoveFileLogEntryA (ANSI)

See also

Overview
Functions
SetupLogFile

 

 

Show: