msiGetPropertyA 函式 (msiquery.h)

MsiGetProperty 函式會取得安裝程序屬性的值。

語法

UINT MsiGetPropertyA(
  [in]      MSIHANDLE hInstall,
  [in]      LPCSTR    szName,
  [out]     LPSTR     szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

參數

[in] hInstall

處理提供給 DLL 自定義動作的安裝，或透過 MsiOpenPackage、 MsiOpenPackageEx 或 MsiOpenProduct 取得。

[in] szName

指定屬性名稱的 Null 終止字串。

[out] szValueBuf

緩衝區的指標，這個緩衝區會接收包含 屬性值的Null 終止字元串。 請勿嘗試藉由傳入 szValueBuf 的 null (值=0) ，來判斷緩衝區的大小。 您可以藉由傳入空字串來取得緩衝區的大小 (，例如 “”) 。 然後函式會傳回 ERROR_MORE_DATA，pchValueBuf 會在 TCHAR 中包含必要的緩衝區大小，不包括終止的 Null 字元。 傳回ERROR_SUCCESS時， pcchValueBuf 會包含寫入緩衝區的 TCHA 數目，不包括終止的 Null 字元。

[in, out] pcchValueBuf

變數的指標，指定變數 szValueBuf 所指向之緩衝區的大小，以 TCHAR 為單位。 當函式傳回ERROR_SUCCESS時，此變數會包含複製到 szValueBuf 的數據大小，不包括終止的 Null 字元。 如果 szValueBuf 不夠大，則函式會傳回ERROR_MORE_DATA並儲存必要的大小，不包括 pchValueBuf 所指向的變數中終止 Null 字元。

傳回值

此函式會傳回UINT。

備註

如果未定義 MsiGetProperty 函式所擷取之屬性的值，則相當於 0 長度的值。 這並不是錯誤。

如果傳回ERROR_MORE_DATA，則為指標的參數會提供保存字串所需的緩衝區大小。 如果傳回ERROR_SUCCESS，它會提供寫入字串緩衝區的字元數。 因此，您可以藉由傳入空字串 (，例如指定緩衝區之參數的 “”) ，以取得緩衝區的大小。 請勿嘗試藉由傳入 Null (value=0) 來判斷緩衝區的大小。

下列範例示範 DLL 自定義動作如何透過動態判斷值緩衝區的大小來存取屬性值。

UINT __stdcall MyCustomAction(MSIHANDLE hInstall)
{
    TCHAR* szValueBuf = NULL;
    DWORD cchValueBuf = 0;
    UINT uiStat =  MsiGetProperty(hInstall, TEXT("MyProperty"), TEXT(""), &cchValueBuf);
    //cchValueBuf now contains the size of the property's string, without null termination
    if (ERROR_MORE_DATA == uiStat)
    {
        ++cchValueBuf; // add 1 for null termination
        szValueBuf = new TCHAR[cchValueBuf];
        if (szValueBuf)
        {
            uiStat = MsiGetProperty(hInstall, TEXT("MyProperty"), szValueBuf, &cchValueBuf);
        }
    }
    if (ERROR_SUCCESS != uiStat)
    {
        if (szValueBuf != NULL) 
           delete[] szValueBuf;
        return ERROR_INSTALL_FAILURE;
    }

    // custom action uses MyProperty
    // ...

    delete[] szValueBuf;

    return ERROR_SUCCESS;
}

注意

msiquery.h 標頭會將 MsiGetProperty 定義為別名，根據 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。 Windows Server 2003 或 Windows XP 上的 Windows Installer
目標平台	Windows
標頭	msiquery.h
程式庫	Msi.lib
Dll	Msi.dll

另請參閱

安裝程式狀態存取函式

傳遞 Null 作為 Windows Installer 函式的自變數