SetupLogFileW 函数 (setupapi.h)
[此函数可用于“要求”部分所示的操作系统。 它可能在后续版本中变更或不可用。 安装程序API 不应再用于安装应用程序。 请改用 Windows 安装程序来开发应用程序安装程序。 SetupAPI 继续用于安装设备驱动程序。]
SetupLogFile 函数将条目添加到日志文件。
语法
WINSETUPAPI BOOL SetupLogFileW(
[in] HSPFILELOG FileLogHandle,
[in] PCWSTR LogSectionName,
[in] PCWSTR SourceFilename,
[in] PCWSTR TargetFilename,
[in] DWORD Checksum,
[in] PCWSTR DiskTagfile,
[in] PCWSTR DiskDescription,
[in] PCWSTR OtherInfo,
[in] DWORD Flags
);
参数
[in] FileLogHandle
SetupInitializeFileLog 返回的文件日志的句柄。 初始化日志文件时,调用方不得传递SPFILELOG_QUERYONLY。
[in] LogSectionName
指向日志文件中名称逻辑分组的名称的可选指针。 应使用 以 null 结尾的字符串。 如果在初始化文件日志时未传递SPFILELOG_SYSTEMLOG,则是必需的。 否则,此参数可以为 NULL。
[in] SourceFilename
文件存在于安装该文件的源媒体上的名称。 此名称应采用对调用方有意义的任何格式。 应使用 以 null 结尾的字符串。
[in] TargetFilename
目标上存在的文件的名称。 此名称应采用对调用方有意义的任何格式。 应使用 以 null 结尾的字符串。
[in] Checksum
指向校验和值的可选指针。 系统日志是必需的。
[in] DiskTagfile
指向从中安装文件的媒体的标记文件的可选指针。 应使用 以 null 结尾的字符串。 以 null 结尾的字符串不应超过目标缓冲区的大小。 如果未指定SPFILELOG_OEMFILE,则忽略系统日志。 如果指定了SPFILELOG_OEMFILE,则系统日志是必需的。 否则,此参数可以为 NULL。
[in] DiskDescription
指向从中安装文件的媒体的可读说明的可选指针。 应使用 以 null 结尾的字符串。 如果未在 Flags 参数中指定SPFILELOG_OEMFILE,则忽略系统日志。 如果在 Flags 参数中指定了SPFILELOG_OEMFILE,则系统日志是必需的。 否则,此参数可以为 NULL。
[in] OtherInfo
指向要与文件关联的其他信息的可选指针。 应使用 以 null 结尾的字符串。 此参数可以为 NULL。
[in] Flags
此参数可以SPFILELOG_OEMFILE,这仅对系统日志有意义,并指示 Microsoft 未提供该文件。 此参数可用于转换现有文件的条目,例如当 OEM 覆盖 Microsoft 提供的系统文件时。
返回值
如果函数成功,则返回值为非零值。
如果函数失败,则返回值为零。 要获得更多的错误信息,请调用 GetLastError。
注解
注意
setupapi.h 标头将 SetupLogFile 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows XP [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 [仅限桌面应用] |
目标平台 | Windows |
标头 | setupapi.h |
Library | Setupapi.lib |
DLL | Setupapi.dll |