IAccessible：：get_accHelp 方法 (oleacc.h)

發行項
03/05/2024

IAccessible：：get_accHelp 方法會擷取物件的 Help 屬性字串。並非所有物件都支援這個屬性。

語法

HRESULT get_accHelp(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszHelp
);

參數

[in] varChild

類型： VARIANT

指定擷取的說明資訊是否屬於物件或其中一個物件的子專案。這個參數CHILDID_SELF (取得对象) 或子標識碼 (，以取得) 其中一個對象子專案的相關信息。如需初始化 VARIANT 的詳細資訊，請參閱參數中使用子標識碼的方式。

[out, retval] pszHelp

類型： BSTR*

BSTR 的位址，接收包含指定之物件之說明資訊的當地語系化字串，如果沒有可用的說明資訊，則為 NULL。

傳回值

類型： HRESULT

如果成功，則傳回 S_OK。

如果未成功，則傳回下表中的其中一個值，或另一個標準 COM 錯誤碼。伺服器會傳回這些值，但客戶端必須一律檢查輸出參數，以確保它們包含有效的值。如需詳細資訊，請參閱檢查 IAccessible 傳回值。

錯誤	Description
S_FALSE	沒有可用的說明資訊。
E_INVALIDARG	引數無效。
DISP_E_MEMBERNOTFOUND	物件不支援這個屬性。

備註

預先定義和通用控制項都不支援此屬性。

伺服器開發人員的注意事項： 將此屬性傳回的字串本地化。

此屬性會傳回字串，而 IAccessible：：get_accHelpTopic 則提供 WinHelp 中幫助主題的存取權。物件不需要同時支援 IAccessible：：get_accHelp 和 IAccessible：：get_accHelpTopic，但必須至少支援一個。如果它們可以輕鬆地傳回字串，則必須支援 IAccessible：：get_accHelp ;否則，他們必須支援 IAccessible：：get_accHelpTopic。如果支援這兩者， IAccessible：：get_accHelpTopic 會提供更詳細的資訊。

伺服器範例

下列範例程式代碼顯示自定義清單框的這個方法的其中一個可能實作。視清單中的聯繫人狀態而定，會顯示不同的文字。為了簡單起見，此範例不會當地語系化傳回的字串。


// m_pControl is the custom control that returns this accessible object. 
// 'online' is an enumerated value. 

HRESULT STDMETHODCALLTYPE AccServer::get_accHelp( 
    VARIANT varChild,
    BSTR *pszHelp)
{
    *pszHelp = NULL;
    if (varChild.vt != VT_I4)
    {
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszHelp = SysAllocString(L"Contact list.");
    }
    else
    {
        int index = (int)varChild.lVal - 1;
        CustomListControlItem* pItem = m_pControl->GetItemAt(index);
        if (pItem == NULL)
        {
            return E_INVALIDARG;
        }
        if (pItem->GetStatus() == online)
        {
            *pszHelp = SysAllocString(L"Online contact.");
        }
        else 
        {
            *pszHelp = SysAllocString(L"Offline contact.");
        }
    }
    return S_OK;
};

規格需求

需求	值
最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
目標平台	Windows
標頭	oleacc.h
程式庫	Oleacc.lib
Dll	Oleacc.dll
可轉散發套件	Windows NT 4.0 上的 Active Accessibility 1.3 RDK 與 SP6 和更新版本和 Windows 95