IAccessible::get_accDescription 메서드(oleacc.h)

아티클
03/05/2024

IAccessible::get_accDescription 메서드는 지정된 개체의 시각적 모양을 설명하는 문자열을 검색합니다. 모든 개체에 설명이 있는 것은 아닙니다.

참고 Description 속성은 종종 잘못 사용되며 Microsoft UI 자동화 지원되지 않습니다. Microsoft Active Accessibility 서버 개발자는 이 속성을 사용하면 안 됩니다. 접근성 및 자동화 시나리오에 대한 자세한 정보가 필요한 경우 UI 자동화 요소 및 컨트롤 패턴에서 지원하는 속성을 사용합니다.

구문

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

매개 변수

[in] varChild

형식: VARIANT

검색된 설명이 개체에 속하는지 또는 개체의 자식 요소 중 하나에 속하는지 여부를 지정합니다. 이 매개 변수는 CHILDID_SELF(개체에 대한 정보를 가져오기 위해) 또는 자식 ID(개체의 자식 요소에 대한 정보를 얻기 위해)입니다. VARIANT 구조를 초기화하는 방법에 대한 자세한 내용은 매개 변수에서 자식 ID를 사용하는 방법을 참조하세요.

[out, retval] pszDescription

형식: BSTR*

지정된 개체를 설명하는 지역화된 문자열을 수신하는 BSTR 의 주소이거나, 이 개체에 설명이 없는 경우 NULL 입니다.

반환 값

형식: HRESULT

성공하면 S_OK를 반환합니다.

성공하지 못하면 다음 테이블의 값 중 하나 또는 다른 표준 COM 오류 코드를 반환합니다. 서버는 이러한 값을 반환하지만 클라이언트는 항상 출력 매개 변수를 검사 유효한 값을 포함해야 합니다. 자세한 내용은 IAccessible 반환 값 확인을 참조하세요.

반환 코드	설명
S_FALSE	지정된 개체에 설명이 없습니다.
E_INVALIDARG	인수가 잘못된 경우.
DISP_E_MEMBERNOTFOUND	지정한 개체는 이 속성을 지원하지 않습니다.

설명

Microsoft Active Accessibility 서버는 직접 주석을 사용하거나, IAccessibleEx 인터페이스를 사용하거나, WM_GETOBJECT 메시지를 처리하는 두 구현과 함께 Microsoft Active Accessibility 및 UI 자동화 함께 구현하여 UI 자동화 대한 지원을 추가할 수 있습니다.

이 속성은 사용자에 대한 개체에 해당하는 텍스트 값을 제공합니다. 설명은 텍스트 전용 브라우저를 사용하는 사용자에 대한 이미지를 설명하기 위해 표시되는 텍스트인 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
재배포 가능 파일	SP6 이상 및 Windows 95를 Windows NT 4.0의 활성 접근성 1.3 RDK