다음을 통해 공유


ITypeInfo::GetDocumentation 메서드(oaidl.h)

설명서 문자열, 전체 도움말 파일 이름과 경로, 지정된 형식 설명에 대한 도움말 항목의 컨텍스트 ID를 검색합니다.

구문

HRESULT GetDocumentation(
  [in]  MEMBERID memid,
  [out] BSTR     *pBstrName,
  [out] BSTR     *pBstrDocString,
  [out] DWORD    *pdwHelpContext,
  [out] BSTR     *pBstrHelpFile
);

매개 변수

[in] memid

설명서가 반환되는 멤버의 ID입니다.

[out] pBstrName

지정된 항목의 이름입니다. 호출자에게 항목 이름이 필요하지 않은 경우 pBstrName 은 null일 수 있습니다.

[out] pBstrDocString

지정된 항목에 대한 설명서 문자열입니다. 호출자에게 설명서 문자열이 필요하지 않은 경우 pBstrDocString 은 null일 수 있습니다.

[out] pdwHelpContext

도움말 지역화 컨텍스트입니다. 호출자에게 도움말 컨텍스트가 필요하지 않은 경우 null일 수 있습니다.

[out] pBstrHelpFile

도움말 파일에 사용되는 DLL을 포함하는 파일의 정규화된 이름입니다. 호출자에게 파일 이름이 필요하지 않은 경우 null일 수 있습니다.

반환 값

이 메서드는 이러한 값 중 하나를 반환할 수 있습니다.

반환 코드 설명
S_ok
성공.
E_INVALIDARG
하나 이상의 인수가 잘못되었습니다.
E_OUTOFMEMORY
메모리가 부족하여 작업을 완료할 수 없습니다.

설명

GetDocumentation 함수는 memid 매개 변수로 지정된 멤버에 대한 설명서에 대한 액세스를 제공합니다. 전달된 memid 가 MEMBERID_NIL 경우 형식 설명에 대한 설명서가 반환됩니다.

형식 설명이 다른 형식 설명에서 상속되는 경우 이 함수는 필요한 경우 요청된 멤버 ID가 있는 항목을 찾기 위해 기본 형식 설명에 재귀적입니다.

호출자는 SysFreeString을 사용하여 pBstrName, pBstrDocStringpBstrHelpFile에서 참조하는 BSTR을 해제해야 합니다.

요구 사항

요구 사항
대상 플랫폼 Windows
헤더 oaidl.h

추가 정보

Itypeinfo