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

아티클
03/05/2024

IAccessible::get_accHelp 메서드는 개체의 도움말 속성 문자열을 검색합니다. 모든 개체가 이 속성을 지원하는 것은 아닙니다.

구문

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

매개 변수

[in] varChild

형식: VARIANT

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

[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
재배포 가능 파일	SP6 이상 및 Windows 95를 Windows NT 4.0의 활성 접근성 1.3 RDK