IAccessible：：get_accRole 方法 (oleacc.h)

IAccessible：：get_accRole 方法检索描述指定对象角色的信息。 所有对象都支持此属性。

语法

HRESULT get_accRole(
  [in]          VARIANT varChild,
  [out, retval] VARIANT *pvarRole
);

参数

[in] varChild

类型： VARIANT

指定检索的角色信息是属于对象还是对象子元素之一。 此参数CHILDID_SELF (获取有关对象) 的信息或子 ID (以获取有关对象子元素的信息) 。 有关初始化 VARIANT 的详细信息，请参阅 参数中如何使用子 ID。

[out, retval] pvarRole

类型： VARIANT*

接收对象角色常量的 VARIANT 的地址。 vt 成员必须VT_I4。 lVal 成员接收对象角色常量。

返回值

类型： HRESULT

如果成功，则返回 S_OK。

如果未成功，则返回下表中的一个值，或返回另一个标准 COM 错误代码。 服务器返回这些值，但客户端必须始终检查输出参数，以确保它们包含有效值。 有关详细信息，请参阅 检查 IAccessible 返回值。

错误	说明
E_INVALIDARG	自变量无效。

注解

客户端调用 GetRoleText 以检索描述对象角色的本地化字符串。

记下服务器开发人员： 必须使用预定义的角色常量。

服务器示例

以下示例代码是自定义列表框的可能实现，用于维护其自己的列表项。

HRESULT STDMETHODCALLTYPE AccServer::get_accRole( 
    VARIANT varChild,
    VARIANT *pvarRole)
{
    if (varChild.vt != VT_I4)
    {
        pvarRole->vt = VT_EMPTY;
        return E_INVALIDARG;
    }

    pvarRole->vt = VT_I4;

    if (varChild.lVal == CHILDID_SELF)
    {
        pvarRole->lVal = ROLE_SYSTEM_LIST;
    }
    else
    {
        pvarRole->lVal = ROLE_SYSTEM_LISTITEM;
    }
    return S_OK;
};

客户端示例

以下示例函数显示辅助对象或子元素的角色。

HRESULT PrintRole(IAccessible* pAcc, long childId)
{
    DWORD roleId;
    if (pAcc == NULL)
    {
        return E_INVALIDARG;    
    }
    VARIANT varChild;
    varChild.vt = VT_I4;
    varChild.lVal = childId;
    VARIANT varResult;
    HRESULT hr = pAcc->get_accRole(varChild, &varResult);
    if ((hr == S_OK) && (varResult.vt == VT_I4))
    {
        roleId = varResult.lVal;
        UINT   roleLength;
        LPTSTR lpszRoleString;

        // Get the length of the string. 
        roleLength = GetRoleText(roleId, NULL, 0);

        // Allocate memory for the string. Add one character to 
        // the length you got in the previous call to make room 
        // for the null character. 
        lpszRoleString = (LPTSTR)malloc((roleLength+1) * sizeof(TCHAR));
        if (lpszRoleString != NULL)
        {
            // Get the string. 
            GetRoleText(roleId, lpszRoleString, roleLength + 1);
#ifdef UNICODE
            printf("Role: %S\n", lpszRoleString);
#else
            printf(("Role: %s\n", lpszRoleString);
#endif
            // Free the allocated memory 
            free(lpszRoleString);
        }
        else 
        {
            return E_OUTOFMEMORY;
        }
    }
    return S_OK;
}

要求

最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows Server 2003 [仅限桌面应用]
目标平台	Windows
标头	oleacc.h
Library	Oleacc.lib
DLL	Oleacc.dll
可再发行组件	使用 SP6 及更高版本和 Windows 95 Windows NT 4.0 上的活动辅助功能 1.3 RDK

请参阅

GetRoleText

IAccessible

Role 属性

VARIANT