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 (值=0) ,來判斷緩衝區的大小。 您可以藉由傳入空字串來取得緩衝區的大小 (,例如 “”) 。 然後函式會傳回 ERROR_MORE_DATA , 而pcchValueBuf 包含TCHAR中所需的緩衝區大小,不包括終止的Null字元。 傳回 ERROR_SUCCESS時, pcchValueBuf 包含寫入緩衝區的 TCHAR 數目,不包括終止的 Null 字元。
[in, out] pcchValueBuf
指定變數 szValueBuf 所指向之緩衝區大小的 TCHARs 變數指標。 當函式傳回 ERROR_SUCCESS時,此變數會包含複製到 szValueBuf 的數據大小,不包括終止的 Null 字元。 如果 szValueBuf 不夠大,函式會傳回 ERROR_MORE_DATA 並儲存必要的大小,不包括 pcchValueBuf 所指向的變數中終止的 Null 字元。
傳回值
MsiRecordGetString 函式會傳回下列其中一個值:
備註
如果 傳回ERROR_MORE_DATA ,則為指標的參數會提供保存字串所需的緩衝區大小。 如果 傳回ERROR_SUCCESS ,它會提供寫入字串緩衝區的字元數。 若要取得緩衝區的大小,請以 szValueBuf 的形式傳入 1 個字元緩衝區的位址,並將 具有 pcchValueBuf 的緩衝區大小指定為 0。 這可確保函式不會傳回任何字串值放入緩衝區中。 請勿嘗試藉由傳入 Null (value=0) 來判斷緩衝區的大小。
注意
msiquery.h 標頭會根據 UNICODE 預處理器常數的定義,將 MsiRecordGetString 定義為別名,自動選取此函式的 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。 |
目標平台 | Windows |
標頭 | msiquery.h |
程式庫 | Msi.lib |
Dll | Msi.dll |