ITypeLib::GetDocumentation 메서드(oaidl.h)
라이브러리에 대한 설명서 문자열, 전체 도움말 파일 이름 및 경로 및 도움말 파일의 라이브러리 도움말 항목에 대한 컨텍스트 식별자를 검색합니다.
구문
HRESULT GetDocumentation(
[in] INT index,
[out] BSTR *pBstrName,
[out] BSTR *pBstrDocString,
[out] DWORD *pdwHelpContext,
[out] BSTR *pBstrHelpFile
);
매개 변수
[in] index
반환될 설명서가 있는 형식 설명의 인덱스입니다. 인덱스가 -1이면 라이브러리 자체에 대한 설명서가 반환됩니다.
[out] pBstrName
지정된 항목의 이름입니다. 호출자에게 항목 이름이 필요하지 않은 경우 pBstrName 은 null일 수 있습니다.
[out] pBstrDocString
지정된 항목에 대한 설명서 문자열입니다. 호출자에게 설명서 문자열이 필요하지 않은 경우 pBstrDocString 은 null일 수 있습니다.
[out] pdwHelpContext
지정된 항목과 연결된 도움말 컨텍스트 식별자(ID)입니다. 호출자에게 도움말 컨텍스트 ID가 필요하지 않은 경우 pdwHelpContext 는 null일 수 있습니다.
[out] pBstrHelpFile
도움말 파일의 정규화된 이름입니다. 호출자에게 도움말 파일 이름이 필요하지 않은 경우 pBstrHelpFile 은 null일 수 있습니다.
반환 값
이 메서드는 이러한 값 중 하나를 반환할 수 있습니다.
반환 코드 | 설명 |
---|---|
|
성공. |
|
하나 이상의 인수가 잘못되었습니다. |
|
메모리가 부족하여 작업을 완료할 수 없습니다. |
설명
호출자는 pBstrName, pBstrDocString 및 pBstrHelpFile 매개 변수를 해제해야 합니다.
요구 사항
요구 사항 | 값 |
---|---|
대상 플랫폼 | Windows |
헤더 | oaidl.h |