IDisplayHelp::ShowTopic 메서드(mmc.h)
IDisplayHelp::ShowTopic 메서드는 병합된 MMC HTML 도움말 파일에 지정된 HTML 도움말 항목을 표시합니다.
구문
HRESULT ShowTopic(
[in] LPOLESTR pszHelpTopic
);
매개 변수
[in] pszHelpTopic
병합된 MMC HTML 도움말 파일에 표시할 토픽을 지정하는 NULL로 끝나는 문자열에 대한 포인터입니다. 문자열의 형식은 다음과 같습니다.
helpfilename::topicfilename
여기서 helpfilename 은 MMC가 MMC HTML 도움말 컬렉션 파일에 병합한 스냅인의 HTML 도움말 파일(.chm)의 파일 이름이며(원래 HTML 도움말 파일의 경로가 아닌 파일 이름만 해당) topicfilename 은 스냅인의 .chm 파일 내에서 토픽 파일의 내부 경로입니다. 스냅인의 HTML 도움말 파일 작성자는 항목 HTML 파일에 대한 내부 디렉터리 구조가 있는지 또는 모든 항목 HTML 파일이 .chm 파일의 루트에 있는지 여부를 결정합니다.
스냅인은 ISnapinHelp2::GetHelpTopic 메서드 구현에서 해당 .chm 파일에 대해 MMC에 알릴 수 있습니다.
예를 들어 스냅인에 MMC HTML 도움말 컬렉션 파일에 병합된 HTML 도움말 파일 mysnapin.chm과 내부 파일 경로가 htm/help01.htm 토픽 HTML 파일이 있는 경우 문자열의 형식은 다음과 같습니다.
mysnapin.chm::htm/help01.htm
대신 help01.htm 토픽 파일이 mysnapin.chm 도움말 파일의 루트에 있는 경우 문자열에는 다음 형식이 있어야 합니다.
mysnapin.chm::/help01.htm
topics 대한 숫자 ID에 대한 지원은 버전 1.2 이하에 포함되지 않습니다.
반환 값
이 메서드는 이러한 값 중 하나를 반환할 수 있습니다.
설명
MMC 버전 1.0 및 1.1은 pszHelpTopic 을 COM API 함수 CoTaskMemAlloc과 함께 할당해야 하며, MMC가 문자열을 해제해야 합니다. 이는 매개 변수 내 할당에 대한 COM 규칙을 위반하여 호출자(스냅인)가 할당하고 해제해야 합니다. MMC 1.2 및 MMC 2.0에서는 더 이상 pszHelpTopic 을 CoTaskMemAlloc과 함께 할당할 필요가 없습니다. 호출자는 원하는 메모리 관리를 자유롭게 사용할 수 있습니다. 호출자가 CoTaskMemAlloc를 사용하도록 선택하는 경우 CoTaskMemFree 를 호출하여 문자열을 해제해야 합니다.
스냅인은 IComponent::Notify 메서드에서 MMCN_CONTEXTHELP 알림을 처리하고 IDisplayHelp::ShowTopic을 호출하여 선택한 항목에 대한 컨텍스트 도움말을 제공할 수 있습니다.
속성 페이지의 경우 스냅인은 IDisplayHelp::ShowTopic 대신 MMCPropertyHelp를 호출해야 합니다. MMC 속성 시트는 일반적으로 별도의 스레드에서 실행되므로 속성 페이지에서 IDisplayHelp 인터페이스를 직접 사용할 수 없습니다. 대신 속성 페이지에서 MMC 라이브러리에서 MMCPropertyHelp 를 호출하여 동일한 결과를 얻을 수 있습니다. MMCPropertyHelp는 IDisplayHelp::ShowTopic과 동일한 토픽 문자열 매개 변수를 사용하고 기본 MMC 스레드에 대한 요청을 마샬링하는 작업을 처리합니다.
스냅인에서 MMCN_CONTEXTHELP 알림을 처리하는 경우 MMC는 스냅인에서 선택한 항목에 대한 도움말 항목을 지정할 것으로 예상합니다. 따라서 MMCN_CONTEXTHELP 알림에 대한 알림 처리기에서 스냅인에는 다음 두 가지 옵션이 있습니다.
- IDisplayHelp::ShowTopic 또는 MMCPropertyHelp를 호출하여 도움말 항목을 지정한 다음 S_OK 반환하여 성공을 나타낼 수 있습니다. 스냅인은 도움말 항목을 지정하는 경우에만 S_OK 반환해야 합니다. 도움말 항목을 지정하지 않고 스냅인에서 S_OK 반환하면 도움말 항목이 표시되지 않습니다.
- 알림에 S_FALSE 반환할 수 있습니다. 그런 다음, MMC는 기본 MMC 항목이 선택된 도움말 컬렉션 파일을 표시합니다.
요구 사항
지원되는 최소 클라이언트 | Windows Vista |
지원되는 최소 서버 | Windows Server 2008 |
대상 플랫폼 | Windows |
헤더 | mmc.h |
DLL | Mmcndmgr.dll |