WinHelpA 함수(winuser.h)
Windows 도움말(Winhelp.exe)을 시작하고 애플리케이션에서 요청한 도움말의 특성을 나타내는 추가 데이터를 전달합니다.
구문
BOOL WinHelpA(
HWND hWndMain,
LPCSTR lpszHelp,
UINT uCommand,
ULONG_PTR dwData
);
매개 변수
hWndMain
형식: HWND
도움말을 요청하는 창에 대한 핸들입니다. WinHelp 함수는 이 핸들을 사용하여 도움을 요청한 애플리케이션을 추적합니다. uCommand 매개 변수가 HELP_CONTEXTMENU 또는 HELP_WM_HELP 지정하는 경우 hWndMain은 도움을 요청하는 컨트롤을 식별합니다.
lpszHelp
형식: LPCTSTR
필요한 경우 경로가 포함된 null로 끝나는 문자열의 주소와 WinHelp 에서 표시할 도움말 파일의 이름입니다.
항목이 주 창이 아닌 보조 창에 표시될 경우 파일 이름 뒤에 꺾쇠 괄호(>) 및 보조 창의 이름이 뒤따를 수 있습니다. 도움말 프로젝트(.hpj) 파일의 [WINDOWS] 섹션에서 보조 창의 이름을 정의해야 합니다.
uCommand
형식: UINT
요청된 도움말의 유형입니다. 가능한 값 목록과 dwData 매개 변수에 배치할 값에 미치는 영향은 주의 섹션을 참조하세요.
dwData
형식: ULONG_PTR
추가 데이터. 사용되는 값은 uCommand 매개 변수의 값에 따라 달라집니다. 가능한 dwData 값 목록은 주의 섹션을 참조하세요.
반환 값
형식: BOOL
성공하면 0이 아닌 값을 반환하고 그렇지 않으면 0을 반환합니다. 확장된 오류 정보를 검색하려면 GetLastError를 호출합니다.
설명
도움을 요청한 창을 닫기 전에 애플리케이션은 uCommand 매개 변수가 HELP_QUIT 설정된 WinHelp를 호출해야 합니다. 모든 애플리케이션이 이 작업을 수행할 때까지 Windows 도움말은 종료되지 않습니다. HELP_CONTEXTPOPUP 명령을 사용하여 Windows 도움말을 시작한 경우에는 HELP_QUIT 명령을 사용하여 Windows 도움말을 호출할 필요가 없습니다.
현재 사용자를 제외한 모든 컨텍스트에서 호출되면 이 함수가 실패합니다.
다음 표에서는 uCommand 매개 변수의 가능한 값과 dwData 매개 변수의 해당 형식을 보여 줍니다.
uCommand | 작업 | dwData |
---|---|---|
HELP_COMMAND | 도움말 매크로 또는 매크로 문자열을 실행합니다. | 실행할 도움말 매크로의 이름을 지정하는 문자열의 주소입니다. 문자열이 여러 매크로 이름을 지정하는 경우 이름을 세미콜론으로 구분해야 합니다. Windows 도움말은 긴 이름을 지원하지 않으므로 일부 매크로에 대해 짧은 형태의 매크로 이름을 사용해야 합니다. |
HELP_CONTENTS | .hpj 파일의 [OPTIONS] 섹션에서 Contents 옵션으로 지정된 항목을 표시합니다. 이 명령은 이전 버전과의 호환성을 위한 것입니다. 새 애플리케이션은 .cnt 파일을 제공하고 HELP_FINDER 명령을 사용해야 합니다. | 무시; 을 0으로 설정합니다. |
HELP_CONTEXT | .hpj 파일의 [MAP] 섹션에 정의된 지정된 컨텍스트 식별자에 의해 식별된 토픽을 표시합니다. | 토픽의 컨텍스트 식별자를 포함합니다. |
HELP_CONTEXTMENU | 선택한 창에 대한 도움말 메뉴를 표시한 다음, 선택한 컨트롤에 대한 항목을 팝업 창에 표시합니다. | DWORD 쌍 배열의 주소입니다. 각 쌍의 첫 번째 DWORD 는 컨트롤 식별자이고 두 번째는 토픽의 컨텍스트 식별자입니다. 배열은 0 {0,0}쌍으로 종료되어야 합니다. 특정 컨트롤에 도움말을 추가하지 않으려면 컨텍스트 식별자를 -1로 설정합니다. |
HELP_CONTEXTPOPUP | 팝업 창에서 .hpj 파일의 [MAP] 섹션에 정의된 지정된 컨텍스트 식별자에 의해 식별된 토픽을 표시합니다. | 토픽의 컨텍스트 식별자를 포함합니다. |
HELP_FINDER | 도움말 항목 대화 상자를 표시합니다. | 무시; 을 0으로 설정합니다. |
HELP_FORCEFILE | Windows 도움말에 올바른 도움말 파일이 표시되는지 확인합니다. 잘못된 도움말 파일이 표시되면 Windows 도움말이 올바른 도움말을 엽니다. 그렇지 않으면 작업이 없습니다. | 무시; 을 0으로 설정합니다. |
HELP_HELPONHELP | Winhlp32.hlp 파일을 사용할 수 있는 경우 Windows 도움말을 사용하는 방법에 대한 도움말을 표시합니다. | 무시; 을 0으로 설정합니다. |
HELP_INDEX | .hpj 파일의 [OPTIONS] 섹션에서 Contents 옵션으로 지정된 항목을 표시합니다. 이 명령은 이전 버전과의 호환성을 위한 것입니다. 새 애플리케이션은 HELP_FINDER 명령을 사용해야 합니다. | 무시; 을 0으로 설정합니다. |
HELP_KEY | 정확히 일치하는 항목이 있는 경우 지정된 키워드(keyword) 일치하는 항목을 키워드(keyword) 테이블에 표시합니다. 일치하는 항목이 두 개 이상 있는 경우 항목 찾음 목록 상자에 나열된 topics 있는 인덱스를 표시합니다. | 키워드(keyword) 문자열의 주소입니다. 여러 키워드를 세미콜론으로 구분해야 합니다. |
HELP_MULTIKEY | 대체 키워드(keyword) 테이블에 키워드(keyword) 지정한 항목을 표시합니다. | 테이블 각주 문자와 키워드(keyword) 지정하는 MULTIKEYHELP 구조체의 주소입니다. |
HELP_PARTIALKEY | 정확히 일치하는 항목이 있는 경우 지정된 키워드(keyword) 일치하는 항목을 키워드(keyword) 테이블에 표시합니다. 일치하는 항목이 두 개 이상 있으면 항목 발견 대화 상자가 표시됩니다. 키워드(keyword) 전달하지 않고 인덱스 표시하려면 빈 문자열에 대한 포인터를 사용합니다. | 키워드(keyword) 문자열의 주소입니다. 여러 키워드를 세미콜론으로 구분해야 합니다. |
HELP_QUIT | 더 이상 필요하지 않음을 Windows 도움말에 알릴 수 있습니다. 다른 응용 프로그램에서 도움을 요청하지 않은 경우 Windows는 Windows 도움말을 닫습니다. | 무시; 을 0으로 설정합니다. |
HELP_SETCONTENTS | 콘텐츠 항목을 지정합니다. 도움말 파일에 연결된 .cnt 파일이 없는 경우 사용자가 콘텐츠 단추를 클릭하면 Windows 도움말이 이 항목을 표시합니다. | Contents 토픽의 컨텍스트 식별자를 포함합니다. |
HELP_SETPOPUP_POS | 후속 팝업 창의 위치를 설정합니다. | 위치 데이터를 포함합니다. MAKELONG을 사용하여 가로 및 세로 좌표를 단일 값으로 연결합니다. 팝업 창은 팝업 창이 호출될 때 마우스 커서가 지정된 지점에 있는 것처럼 배치됩니다. |
HELP_SETWINPOS | Windows 도움말 창이 최소화되거나 메모리에 있는 경우 를 표시하고 크기 및 위치를 지정된 대로 설정합니다. | 기본 또는 보조 도움말 창의 크기와 위치를 지정하는 HELPWININFO 구조체의 주소입니다. |
HELP_TCARD | 명령이 Windows 도움말의 학습 카드 instance 위한 것임을 나타냅니다. 비트 OR 연산자를 사용하여 이 명령을 다른 명령과 결합합니다. | 이 명령이 결합된 명령에 따라 달라집니다. |
HELP_WM_HELP | 팝업 창에서 hWndMain 매개 변수로 식별된 컨트롤에 대한 항목을 표시합니다. | DWORD 쌍 배열의 주소입니다. 각 쌍의 첫 번째 DWORD 는 컨트롤 식별자이고 두 번째는 토픽의 컨텍스트 식별자입니다. 배열은 0 쌍으로 종료되어야 합니다.{0,0} 특정 컨트롤에 도움말을 추가하지 않으려면 컨텍스트 식별자를 -1로 설정합니다. |
참고
winuser.h 헤더는 WINHelp을 유니코드 전처리기 상수의 정의에 따라 이 함수의 ANSI 또는 유니코드 버전을 자동으로 선택하는 별칭으로 정의합니다. 인코딩 중립 별칭을 인코딩 중립이 아닌 코드와 혼합하면 컴파일 또는 런타임 오류가 발생하는 불일치가 발생할 수 있습니다. 자세한 내용은 함수 프로토타입에 대한 규칙을 참조하세요.
요구 사항
요구 사항 | 값 |
---|---|
지원되는 최소 클라이언트 | Windows XP [데스크톱 앱만 해당] |
지원되는 최소 서버 | Windows 2000 Server[데스크톱 앱만] |
대상 플랫폼 | Windows |
헤더 | winuser.h |
라이브러리 | User32.lib |
DLL | User32.dll |
API 세트 | ext-ms-win-ntuser-misc-l1-5-1(Windows 10 버전 10.0.14393에 도입됨) |