DGRegisterAdditionalHelpLocation

AddOn의 자체 도움말 엔진 위치를 MDID와 경로를 이용하여 등록합니다.

    bool DGRegisterAdditionalHelpLocation (
      Int32                 developerId,
      Int32                 localId,
      const GS::UniString*  localHelpPath,
      const GS::UniString*  localHelpFile,
      const GS::UniString*  helpWebAddress,
      const GS::UniString*  tmpPath,
      const GS::UniString*  helpParameters
    );

파라미터

developerId

입력 파라미터: AddOn의 MDID의 DeveloperID 파트입니다.

 

localId

입력 파라미터: AddOn의 MDID의 LocalID 파트입니다.

 

localHelpPath

입력 파라미터: 로컬 머신의 도움말 엔진에 대한 경로입니다.

 

localHelpFile

입력 파라미터: 도움말 엔진 파일명입니다. (만약 NULL이면, 'index.html'로 가정함)

 

helpWebAddress

입력 파라미터: 도움말 웹사이트의 URL입니다. (예. http://help.graphisoft.com ) (localHelpPath가 NULL일 때에만 유효함)

 

tmpPath

입력 파라미터: 로컬 머신의 임시 디렉토리에 대한 경로입니다.

 

helpParameters

입력 파라미터: 도움말 URL의 끝에 추가되는 추가적인 파라미터들입니다.

리턴 값

값	의미
true	지정한 helpPath가 성공적으로 등록되었습니다. 이 MDID로 이미 등록된 helpPath가 있었습니다.
false	지정한 helpPath가 성공적으로 등록되었습니다. 이 MDID로 등록된 helpPath가 없었습니다.

만약 AddOn이 사용자 인터페이스를 갖고 있으며, 컨텍스트 인식 도움말 정보를 제공하지 않는다면, 초기화할 동안 자체 도움말 엔진의 경로를 등록해야 합니다. 이것은 의무입니다. 왜냐하면 DG가 도움말 앵커 정보를 엔진에게 파라미터로 전달하고, 엔진은 그 파라미터를 처리하여 가장 적합한 컨텍스트 인식 정보를 가져와야 합니다. 만약 등록된 엔진이 없다면, DG는 도움말 앵커를 어디로 전달해야 할지 알 수 없습니다.

AddOn 언로드 단계에서 당신은 helpPath를 등록 해제해야 합니다: DGUnregisterAdditionalHelpLocation.

설명

도움말 엔진은 HTML-기반 index.html 루트라고 가정합니다. 그리고 DG는 anchor 변수에 도움말 앵커 파라미터를 넣어서 엔진에게 전달합니다.

도움말 앵커 구문 규칙들과 다이얼로그 도움말 포맷의 GRC 사양에 대한 더 많은 정보는 여기서 찾을 수 있습니다: 다이얼로그 도움말의 GRC 사양.

요구사항

버전: DG 2.1.0.66 또는 이후

헤더: DG.h

라이브러리 가져오기: DG.lib [WIN]

모듈: DGLib [MAC], DG.dll [WIN]

참고사항

DG 함수, DGUnregisterAdditionalHelpLocation
다이얼로그 도움말의 GRC 사양
DGDisplayContextHelp, DGShowContextHelpWithAnchor, DGGetDynamicHelpStrings