IAccessible：：get_accDescription 方法 (oleacc.h)

發行項
03/13/2024

IAccessible：：get_accDescription 方法會擷取描述指定對象的視覺外觀的字串。並非所有的物件都有描述。

注意Description 屬性通常不正確使用，且 Microsoft 使用者介面自動化不支援。 Microsoft Active Accessibility 伺服器開發人員不應該使用此屬性。如果輔助功能和自動化案例需要詳細資訊，請使用使用者介面自動化專案和控制模式所支援的屬性。

語法

HRESULT get_accDescription(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszDescription
);

參數

[in] varChild

類型： VARIANT

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

[out, retval] pszDescription

類型： BSTR*

BSTR 的位址，該字串會接收描述指定之物件的當地語系化字串，如果這個對象沒有描述，則為 NULL。

傳回值

類型： HRESULT

如果成功，則傳回 S_OK。

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

傳回碼	Description
S_FALSE	指定的物件沒有描述。
E_INVALIDARG	引數無效。
DISP_E_MEMBERNOTFOUND	指定的物件不支援這個屬性。

備註

Microsoft Active Accessibility 伺服器可以使用直接註釋、使用 IAccessibleEx 介面，或實作 Microsoft Active Accessibility 和使用者介面自動化並存處理WM_GETOBJECT訊息的實作，來新增對使用者介面自動化的支援。

這個屬性會為使用者提供物件的文字對等專案。描述應該類似於 HTML 中 ALT 屬性所提供的文字，這是用來描述使用純文字瀏覽器之人員影像的文字。不過，有些控件會使用這個屬性來儲存與文字對等項目無關之控件的額外資訊。如需此屬性的詳細資訊，請參閱 Description 屬性。

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

伺服器範例

下列範例程式代碼顯示這個方法的其中一個可能實作，適用於維護自己的子元素的自定義清單框。此範例示範語法，但請記住，純文本清單框可能不需要支援此屬性。為了簡單起見，範例中的字串不會當地語系化。


HRESULT STDMETHODCALLTYPE AccServer::get_accDescription( 
    VARIANT varChild,
    BSTR *pszDescription)
{
    if (varChild.vt != VT_I4)
    {
        *pszDescription = NULL;
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszDescription = SysAllocString(L"List of contacts.");    
            
    }
    else
    {
        *pszDescription = SysAllocString(L"A contact.");           
            
    }
    return S_OK;
};

用戶端範例

下列範例函式會擷取指定之可存取物件或子專案的描述，並在控制台上顯示它。


HRESULT PrintDescription(IAccessible* pAcc, long child)
{
    VARIANT varObject;
    varObject.vt = VT_I4;
    varObject.lVal = child;
    BSTR bstrDesc;
    HRESULT hr = pAcc->get_accDescription(varObject, &bstrDesc);
    if (hr == S_OK)
    {
        printf("Description: %S\n", bstrDesc);
        SysFreeString(bstrDesc);
    }
    return hr;
}

規格需求

需求	值
最低支援的用戶端	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