MsiRecordGetStringA 函数 (msiquery.h)

MsiRecordGetString 函数返回记录字段的字符串值。

语法

UINT MsiRecordGetStringA(
  [in]      MSIHANDLE hRecord,
  [in]      UINT      iField,
  [out]     LPSTR     szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

参数

[in] hRecord

记录的句柄。

[in] iField

指定请求的字段。

[out] szValueBuf

指向接收包含记录字段值的 null 终止字符串的缓冲区的指针。 不要尝试通过传入 szValueBuf的 null(value=0)来确定缓冲区的大小。 可以通过传入空字符串来获取缓冲区的大小(例如“)。 然后,该函数返回 ERROR_MORE_DATApcchValueBuf 包含 TCHAR 中所需的缓冲区大小,不包括终止 null 字符。 返回 ERROR_SUCCESS时,pcchValueBuf 包含写入缓冲区的 TCHA R 数,不包括终止 null 字符。

[in, out] pcchValueBuf

指向指定变量 szValueBuf指向的缓冲区的大小 TCHARs 的变量的指针。 函数返回 ERROR_SUCCESS时,此变量包含复制到 szValueBuf的数据的大小,不包括终止 null 字符。 如果 szValueBuf 不够大,则该函数将返回 ERROR_MORE_DATA 并存储所需的大小(不包括终止 null 字符)pcchValueBuf指向的变量中。

返回值

MsiRecordGetString 函数返回以下值之一:

言论

如果返回 ERROR_MORE_DATA,则为指针的参数提供保存字符串所需的缓冲区大小。 如果返回 ERROR_SUCCESS,它将提供写入字符串缓冲区的字符数。 若要获取缓冲区的大小,请将 1 个字符缓冲区的地址作为 szValueBuf 传入,并将 pcchValueBuf 指定为 0 的缓冲区的大小。 这可确保函数不返回任何字符串值适合缓冲区。 不要尝试通过传入 Null(value=0)来确定缓冲区的大小。

注意

msiquery.h 标头将 MsiRecordGetString 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows Server 2012、Windows 8、Windows Server 2008 R2 或 Windows 7 上的 Windows Installer 5.0。 Windows Server 2008 或 Windows Vista 上的 Windows Installer 4.0 或 Windows Installer 4.5。
目标平台 窗户
标头 msiquery.h
Msi.lib
DLL Msi.dll

另请参阅

将 Null 作为 Windows Installer 函数的参数传递

记录处理函数