ISnapinHelp::GetHelpTopic 메서드(mmc.h)

아티클
08/24/2023

스냅인을 사용하여 컴파일된 HTML 도움말 파일을 MMC 도움말 컬렉션 파일에 추가할 수 있습니다.

구문

HRESULT GetHelpTopic(
  [out] LPOLESTR *lpCompiledHelpFile
);

매개 변수

[out] lpCompiledHelpFile

스냅인에 대해 컴파일된 도움말 파일(.chm)의 경로를 포함하는 null로 끝나는 유니코드 문자열의 주소에 대한 포인터입니다. 경로를 지정할 때 파일을 어디에나 놓고 전체 경로 이름을 지정합니다.

반환 값

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

설명

MMC는 스냅인의 도움말 파일 위치를 가져오기 위해 이 메서드의 스냅인 구현을 호출합니다. MMC는 모든 스냅인의 HTML 도움말 파일을 MMC 콘솔 HTML 도움말 컬렉션 파일과 병합합니다.

스냅인 도움말 파일의 토픽 계층 구조는 컬렉션을 볼 때 목차에 표시됩니다.

MMC는 HTML 도움말 파일을 병합하여 단일 통합 HTML 도움말 목차, 인덱스 및 검색 기능을 만듭니다. 사용자가 기본 도움말 메뉴에서 Microsoft 관리 콘솔의 도움말을 클릭하면 MMC는 현재 콘솔 파일의 모든 스냅인에 대한 HTML 도움말 파일이 포함된 병합된 도움말 파일을 엽니다.

COM API 함수 CoTaskMemAlloc(또는 해당)를 사용하여 lpCompiledHelpFile 문자열을 할당하면 MMC가 릴리스됩니다.

예제

STDMETHODIMP CComponentData::GetHelpTopic( LPOLESTR *lpCompiledFile )
{
    LPOLESTR lpHelpFile;
 
    if ( !lpCompiledFile )
        return E_POINTER; // invalid argument
 
    lpHelpFile = (LPOLESTR) CoTaskMemAlloc( MAX_PATH * sizeof(WCHAR) );
 
    if ( !lpHelpFile )
    {
        return E_OUTOFMEMORY;
    }
 
    ExpandEnvironmentStringsW( L"%SystemRoot%\\Help\\myhelpfile.chm", lpHelpFile, MAX_PATH );
 
    *lpCompiledHelpFile = lpHelpFile;
 
    return S_OK;
}