The information in this document applies to:
This document is a cross-reference of HKPAPI functions / parameters, and hkScript functions that are found in the sample plugins and other published plugins with source code written in all supported languages.
HKPAPI Functions Cross-reference
- hkp_f_Buffer
- hkp_f_ExecuteAndWait
- hkp_f_File
- hkp_f_GetColor
- hkp_f_GetCurrDateTimeFmt
- hkp_f_GetCursorXY
- hkp_f_GetMarks
- hkp_f_GetSetFileContent
- hkp_f_GetStyleCSS
- hkp_f_GetTempFileNameExt
- hkp_f_IconReplace
- hkp_f_InputWizard
hkScript:
demoInputWizardIcons,
demoInputWizardNewPage,
demoIWPickImg,
demoIWUserInput,
hkCompCSharp,
hkPerlTidy,
hkTableFromLines,
hkWinMergeHelper,
hkXWTHelper,
irDebugPHP, ...
- hkp_f_InvokeCommand
demoInvokeCommand,
gmExtChars,
ExtProg,
hkBookmarksCopy,
hkCloseFiles,
hkCompCSharp,
hkDeleteMatchingTags,
hkDuplicateLine,
hkMenuCommands,
hkWinMergeHelper, ...
- hkp_f_LoadFromFile
- hkp_f_NewFile
- hkp_f_OpenBrowser
- hkp_f_OpenFileEx
- hkp_f_PluginDataRead
- hkp_f_PluginDataWrite
- hkp_f_ProcessToken
- hkp_f_Progress
- hkp_f_Recall
- hkp_f_RichHint
- hkp_f_SaveToFile
- hkp_f_SaveToTempFile
- hkp_f_SetCursorXY
- hkp_f_SetMarks
- hkp_f_ShellExecute
- hkp_f_String
- hkp_f_UI_GetFileName
demoShowInBrowser,
hkAutoStyle,
hkCSV2XML,
hkDuplicateLine,
hkFindAndList,
hkFindInFiles,
hkFindOrphanFiles,
hkHTMLCopy,
hkIndexer,
hkLatestFilesIndex, ...
- hkp_f_cmndlgOpen
- hkp_f_cmndlgSave
- hkp_f_gifGetImageInfo
- hkp_f_msgwinAdd
- hkp_f_msgwinClearAll
- hkp_f_regexReplace
- hkp_f_statbarPopMsg
- hkp_f_statbarPushMsg
hkScript Functions Cross-reference
- Alert
AddPara,
bbStripComments,
demoDropDownCombo,
demoGetFileName,
demoGetSelectionOrLine,
demoGetTag,
demoHKSModes,
demoInsertAndSelectText,
demoIWUserInput,
demoMakePHPString, ...
- ExecuteAndWait
- MessageBox
- WinExec
- abs
- array
demoBatchSiteMap,
demoGetPerlOutput,
demoIWPickImg,
demoLinesToWrappedParas,
demoMakePHPString,
demoMultiPageFind,
ergJSPTaglibTags,
gmExtChars,
hkAutoStyle,
hkBatchChangeFNCase, ...
- chartoint
- copy
- del
- exec
- exit
- faccess
ergJSPTaglibTags,
hkAutoStyle,
hkBatchChangeFNCase,
hkBookmarksCopy,
hkCompCSharp,
hkCSV2XML,
hkHTMLCopy,
hkIndexer,
hkLatestFilesIndex,
hkListLinks, ...
- fclose
ergJSPTaglibTags,
hkAutoStyle,
hkBookmarksCopy,
hkCSV2XML,
hkFindInFiles,
hkHTMLCopy,
hkIndexer,
hkLatestFilesIndex,
hkListLinks,
hkPerlTidy, ...
- fgetc
- fgets
- flist
- fmove
- fopen
ergJSPTaglibTags,
hkAutoStyle,
hkBookmarksCopy,
hkCSV2XML,
hkFindInFiles,
hkHTMLCopy,
hkIndexer,
hkLatestFilesIndex,
hkListLinks,
hkPerlTidy, ...
- fputs
- fremove
- fstat
- ftempname
- gettime
- htext
- inttostr
demoBatchSiteMap,
demoIWPickImg,
demoIWUserInput,
demoSessionCount,
ergJSPTaglibTags,
hkBookmarksCopy,
hkClickAndLink,
hkCSV2XML,
hkFindAndList,
hkFindOrphanFiles, ...
- join
- length
demoBatchSiteMap,
demoCmdPromptRun,
demoEchoBatchAction,
demoInputWizardNewPage,
demoInsCodeBlocksWithIndents,
demoInsertAndSelectText,
demoInsertWithIndents,
demoIWPickImg,
demoIWUserInput,
demoLinesToWrappedParas, ...
- pop
- print
- push
- rgather
- rmatch
demoBatchSiteMap,
demoDragDropCSS,
demoIWPickImg,
ergJSPTaglibTags,
hkAutoStyle,
hkBatchChangeFNCase,
hkClickAndLink,
hkCompCSharp,
hkCSV2XML,
hkDragDropExt, ...
- rpos
- rreplace
bbStripComments,
demoInsertAndSelectText,
demoIWPickImg,
demoLinesToWrappedParas,
demoMultiPageFind,
demoRegexReplaceInSelection,
demoReplaceInFullText,
demoShowInBrowser,
gmExtChars,
hkAutoStyle, ...
- rsplit
demoLinesToWrappedParas,
demoMakePHPString,
ergJSPTaglibTags,
hkAutoStyle,
hkBatchLinesCount,
hkBookmarksCopy,
hkClickAndLink,
hkCSV2XML,
hkFindInFiles,
hkFindOrphanFiles, ...
- sort
- sprintf
ergJSP,
ergJSPTaglibTags,
gmExtChars,
hkAutoStyle,
hkBatchLinesCount,
hkBatchWordsCount,
hkClickAndLink,
hkFindInFiles,
hkGetCursorXY,
hkIndexer, ...
- strlwr
ergJSPTaglibTags,
hkAutoStyle,
hkBatchChangeFNCase,
hkCapitalizeWord,
hkCompCSharp,
hkFindAndList,
hkIndexer,
hkLatestFilesIndex,
hkListLinks,
hkTableFromLines, ...
- strtoint
- strupr
- substr
demoEchoBatchAction,
demoMakePHPString,
demoMultiPageFind,
ergJSP,
ergJSPTaglibTags,
gmExtChars,
hkCapitalizeWord,
hkFindDeprecatedTagsInFiles,
hkIndexer,
hkLatestFilesIndex, ...
- unique
- uniques
- use
HKPAPI Parameters Cross-reference
- hkp_ARGV1
hkScript:
AspQuickBar,
bbStripComments,
bsPHPMySQL,
bsStyle,
Carac_spec,
demoControlPanel,
demoEditorContextMenu,
demoHKSModes,
demoMakePHPString,
eeAHref, ...
- hkp_ARGV2
- hkp_AUTHOR
hkScript:
AspQuickBar,
bsStyle,
Carac_spec,
eeAHref,
eeFrames,
eeMetaRefresh,
ergJSPTaglibTags,
hmBatchTOC,
idSpecChars2Entities,
irBBCode, ...
- hkp_BUFFER_CAPTION
- hkp_BUFFER_EVENT_ONEND
- hkp_BUFFER_EVENT_ONENTERFOLDER
- hkp_BUFFER_EVENT_ONEXITFOLDER
- hkp_BUFFER_EVENT_ONINVOKE
- hkp_BUFFER_EVENT_ONSTART
- hkp_BUFFER_HINT
- hkp_BUFFER_IN_CONTENT
- hkp_BUFFER_IN_FILE
- hkp_BUFFER_IN_PARAM1
- hkp_BUFFER_IN_PARAM2
- hkp_BUFFER_PARAM_HINT1
- hkp_BUFFER_PARAM_LABEL1
- hkp_BUFFER_PARAM_LABEL2
- hkp_BUFFER_PARAM_VALUE1
- hkp_BUFFER_PARAM_VALUE2
- hkp_BUTTON_VISIBLE
hkScript:
demoCmdPromptRun,
demoDragDropCSS,
demoEchoBatchAction,
demoEditorContextMenu,
demoInputWizardNewPage,
demoMultiPageFind,
demoPageWizard,
demoPreviewPlugin,
ergJSPTaglibTags,
hkClickAndLink, ...
- hkp_COMBOBOX_EVENT_ONCLICK
- hkp_COMBOBOX_EVENT_ONDROPDOWN
- hkp_COMBOBOX_EVENT_ONKEYPRESS
- hkp_COMBOBOX_ITEM
- hkp_COMBOBOX_ITEMS_DELETE_ALL
- hkp_COMBOBOX_ITEMS_IGNORE_DUPLICATES
- hkp_COMBOBOX_ITEMS_INSERT_TOP
- hkp_COMBOBOX_KEYPRESS_FILTER
- hkp_COMBOBOX_STYLE
- hkp_COMBOBOX_TEXT
- hkp_COMBOBOX_VISIBLE
- hkp_COMBOBOX_WIDTH
- hkp_COMMANDPROMPT_COMMANDS
- hkp_COMMANDPROMPT_EVENT_ONINVOKE
- hkp_COMMANDPROMPT_HELP
- hkp_COMMANDPROMPT_IN_CMDLINE_COMMAND
- hkp_COMMANDPROMPT_IN_CMDLINE_PARAMS
- hkp_COMMANDPROMPT_OUTPUT
- hkp_COMPANY
- hkp_CONTEXTMENU_EDITOR_EVENT_ONCLICK
- hkp_CONTEXTMENU_EDITOR_EVENT_ONCLOSE
- hkp_CONTEXTMENU_EDITOR_EVENT_ONINIT
- hkp_CONTEXTMENU_EDITOR_EVENT_ONOPEN
- hkp_CONTEXTMENU_EDITOR_HINT
- hkp_CONTEXTMENU_EDITOR_HINT_INIT
- hkp_CONTEXTMENU_EDITOR_ICONINDEX
- hkp_CONTEXTMENU_EDITOR_ITEM
- hkp_CONTEXTMENU_EDITOR_ITEM_HINT
- hkp_CONTEXTMENU_EDITOR_ITEM_ICONINDEX
- hkp_CONTEXTMENU_EDITOR_SECTION
- hkp_CONTEXTMENU_EDITOR_VISIBLE
- hkp_COPYRIGHT_LONG
- hkp_COPYRIGHT_SHORT
hkScript:
AspQuickBar,
bsStyle,
Carac_spec,
eeAHref,
eeFrames,
eeMetaRefresh,
ergJSPTaglibTags,
hkAutoStyle,
hkXWTHelper,
idSpecChars2Entities, ...
- hkp_DESCRIPTION
hkScript:
AspQuickBar,
bbStripComments,
bsStyle,
Carac_spec,
ergJSPTaglibTags,
idSpecChars2Entities,
irBBCode,
irDebugPHP,
irShowMatchingParens,
keIndentPHPCode, ...
- hkp_DRAGDROP_ACCEPT_FILEMASKS
- hkp_DRAGDROP_ACCEPT_MODES
- hkp_DRAGDROP_EVENT_ONDROP
- hkp_DRAGDROP_IN_SOURCE_FILE_PATH_REL
- hkp_DRAGDROP_OUTPUT
- hkp_DROPDOWN_ITEM
- hkp_EDITOR_AVAILABLE
- hkp_EDITOR_WINDOW_HANDLE
- hkp_EMAIL
hkScript:
AspQuickBar,
bsStyle,
Carac_spec,
eeAHref,
eeFrames,
eeMetaRefresh,
ergJSPTaglibTags,
idSpecChars2Entities,
irBBCode,
irDebugPHP, ...
- hkp_ENABLED
- hkp_EVENT
hkScript:
demoBatchSiteMap,
demoCmdPromptRun,
demoDragDropCSS,
demoDropDownCombo,
demoDynamicContextMenuIcon,
demoEchoBatchAction,
demoEditorContextMenu,
demoInputWizardNewPage,
demoMultiPageFind,
demoPageWizard, ...
- hkp_FILE_MODIFIED
- hkp_FILE_NAME
- hkp_FILE_NAME_SHORT
- hkp_FILE_TYPE_FILTER_DOCS
- hkp_FUNC_NAME
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoBrowSamp,
demoBatchSiteMap,
demoDynamicContextMenuIcon,
demoEchoBatchAction,
demoInputWizardIcons,
demoInputWizardNewPage,
demoInsertAndSelectText, ...
- hkp_FUNC_P1
- hkp_FUNC_P2
- hkp_FUNC_P3
- hkp_FUNC_P4
- hkp_HELP_CONTEXT
- hkp_HELP_FILE
- hkp_HINT
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoBrowSamp,
demoWinCalc,
demoControlPanel,
demoBatchSiteMap,
demoCmdPromptRun,
demoHKSModes,
demoLinesToWrappedParas, ...
- hkp_HOTKEY
- hkp_ICON_CAPTION
hkScript:
AddPara,
demoBrowSamp,
demoWinCalc,
demoControlPanel,
eeAHref,
eeFrames,
eeMetaRefresh,
ergJSPTaglibTags,
demoExecuteAndWait,
ExtProg, ...
- hkp_ICON_LARGE
- hkp_ICON_SMALL
hkScript:
AspQuickBar,
bbStripComments,
Carac_spec,
demoBatchSiteMap,
demoDrawIcon,
demoInsCodeBlocksWithIndents,
demoMakePHPString,
demoMultiPageFind,
demoProgressWindow,
eeFrames, ...
- hkp_INPUT
hkScript:
bsStyle,
demoDragDropCSS,
demoHKSModes,
demoPreviewPlugin,
demoReplaceInFullText,
ergJSP,
ergJSPTaglibTags,
gmExtChars,
hkDragDropExt,
hkFindAndList, ...
- hkp_INPUT_FILE
demoGetFileName,
demoHKSModes,
ExtProg,
hkAutoStyle,
hkCompCSharp,
hkCSV2XML,
hkHTMLCopy,
hkPerlTidy,
hkSaxonHelper,
hkWinMergeHelper, ...
- hkp_INPUT_LINE_AT_CURSOR
- hkp_INPUT_SELECTED
- hkp_INPUT_TAG_AT_CURSOR
- hkp_INPUT_WORD_AT_CURSOR
- hkp_LABEL_EVENT_ONCLICK
- hkp_LABEL_TEXT
- hkp_LABEL_VISIBLE
- hkp_MAILING_ADDRESS
- hkp_MENU_CAPTION
- hkp_MODE_ADD_MENU_SHORTCUTS
hkScript:
demoMakePHPString,
hkAuthorInfo,
hkCapitalizeWord,
hkCompCSharp,
hkDuplicateLine,
hkFindAndList,
hkHTMLCopy,
hkLatestFilesIndex,
hkMakeOptionsList,
hkPerlTidy, ...
- hkp_MODE_BEGIN_GROUP
- hkp_MODE_BUFFER_ACCESS_READ
- hkp_MODE_BUFFER_ACCESS_WRITE
- hkp_MODE_BUFFER_FILTER_REGEX_EXPR
- hkp_MODE_BUFFER_FILTER_REGEX_OPT
- hkp_MODE_BUFFER_IN_CONTENT
- hkp_MODE_BUFFER_IN_FILE
- hkp_MODE_CONSOLE
- hkp_MODE_CONTEXTMENU_EDITOR_PRELOAD
- hkp_MODE_EDITOR_REQUIRED
hkScript:
demoBatchSiteMap,
demoCmdPromptRun,
demoDragDropCSS,
demoInputWizardNewPage,
demoPageWizard,
hkAutoStyle,
hkBatchChangeFNCase,
hkBatchLinesCount,
hkBatchWordsCount,
hkCSV2XML, ...
- hkp_MODE_EGG
- hkp_MODE_END_GROUP
- hkp_MODE_FOCUS_EDITOR
- hkp_MODE_ICON
hkScript:
AspQuickBar,
bbStripComments,
Carac_spec,
demoBatchSiteMap,
demoDrawIcon,
demoDynamicContextMenuIcon,
demoInputWizardIcons,
demoInsCodeBlocksWithIndents,
demoMakePHPString,
demoMultiPageFind, ...
- hkp_MODE_IN_FILE
demoGetFileName,
demoHKSModes,
ExtProg,
hkAutoStyle,
hkCompCSharp,
hkCSV2XML,
hkHTMLCopy,
hkPerlTidy,
hkSaxonHelper,
hkWinMergeHelper, ...
- hkp_MODE_IN_FILE_EXT
- hkp_MODE_IN_LINE_AT_CURSOR
- hkp_MODE_IN_TAG_AT_CURSOR
- hkp_MODE_IN_TEXT_FULL
hkScript:
demoDragDropCSS,
demoHKSModes,
demoPreviewPlugin,
demoReplaceInFullText,
ergJSPTaglibTags,
TabIndent,
hkDragDropExt,
hkFindAndList,
hkFindOrphanFiles,
hkLineEnd, ...
- hkp_MODE_IN_TEXT_SELECTED
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoGetSelectionOrLine,
demoHKSModes,
demoInsertAndSelectText,
demoLinesToWrappedParas,
demoMakePHPString,
demoRegexReplaceInSelection,
demoReplaceSelection, ...
- hkp_MODE_IN_WORD_AT_CURSOR
- hkp_MODE_MOVE_TO_CARET
AspQuickBar,
bbStripComments,
bsStyle,
Carac_spec,
demoInsCodeBlocksWithIndents,
demoPageWizard,
eeAHref,
eeFrames,
eeMetaRefresh,
ergJSP, ...
- hkp_MODE_OUTPUT
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoBrowSamp,
bsStyle,
demoWinCalc,
Carac_spec,
demoControlPanel,
demoBatchSiteMap,
demoCmdPromptRun, ...
- hkp_MODE_PREPROCESS
- hkp_MODE_PREPROCESS_FORMAT_TAGS
hkScript:
AspQuickBar,
bbStripComments,
bsStyle,
Carac_spec,
demoDragDropCSS,
eeFrames,
ergJSP,
hkAuthorInfo,
hkClickAndLink,
hkConvGTorLT, ...
- hkp_MODE_SAVE_FIRST
- hkp_MODE_SESSION_ENABLE
- hkp_MODE_SHOW_STATUS
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoBrowSamp,
bsStyle,
demoWinCalc,
Carac_spec,
demoControlPanel,
demoHKSModes,
demoProgressWindow, ...
- hkp_NAME
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoBrowSamp,
bsStyle,
demoWinCalc,
Carac_spec,
demoControlPanel,
demoBatchSiteMap,
demoCmdPromptRun, ...
- hkp_OUTPUT
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
bsStyle,
Carac_spec,
demoEditorContextMenu,
demoGetPerlOutput,
demoGetSelectionOrLine,
demoHKSModes,
demoInputWizardNewPage, ...
- hkp_OWNER_WINDOW_HANDLE
- hkp_PATH_PLUGINS
- hkp_PATH_PLUGINS_CONFIG
- hkp_PATH_ROOT
- hkp_PATH_TEMP
- hkp_PHONE
- hkp_PLUGIN_ID
- hkp_PREF_AUTHOR_COMMENTS
- hkp_PREF_AUTHOR_COMPANY
- hkp_PREF_AUTHOR_EMAIL
- hkp_PREF_AUTHOR_NAME
- hkp_PREF_AUTHOR_WEBSITE
- hkp_PREF_DATETIME_FORMAT
- hkp_PREVIEW_EVENT_ONPREVIEW
- hkp_PREVIEW_OUTPUT_CONTENT
- hkp_PREVIEW_OUTPUT_URL
- hkp_PROGRAM_HANDLE
- hkp_RECALL_EVENT_ONINVOKE
- hkp_RECALL_IN_DATA1
- hkp_RECALL_IN_DATA2
- hkp_SECTION
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoBrowSamp,
bsStyle,
demoWinCalc,
Carac_spec,
demoControlPanel,
demoBatchSiteMap,
demoCmdPromptRun, ...
- hkp_SESSION_VAR1
- hkp_SESSION_VAR2
- hkp_SESSION_VAR3
- hkp_SESSION_VAR4
- hkp_SESSION_VAR_COUNT
- hkp_STATUS_PERCENT_COMPLETED
- hkp_TEMPLATEWIZARD_CAPTION
- hkp_TEMPLATEWIZARD_EVENT_ONINVOKE
- hkp_TEMPLATEWIZARD_HINT
- hkp_UPID
- hkp_URL_DOWNLOAD
- hkp_URL_HOME
- hkp_VERSION
hkScript:
AddPara,
AspQuickBar,
bbStripComments,
demoBrowSamp,
bsStyle,
demoWinCalc,
Carac_spec,
demoControlPanel,
demoBatchSiteMap,
demoHKSModes, ...
Document ID: H000154
Audience: Advanced user
Reviewed On: 29-Jun-2003
THE INFORMATION IN THIS DOCUMENT IS PROVIDED ON AN AS-IS BASIS WITHOUT WARRANTY OF ANY KIND.
PROVIDER SPECIFICALLY DISCLAIMS ANY OTHER WARRANTY, EXPRESS OR IMPLIED, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL PROVIDER BE LIABLE FOR ANY CONSEQUENTIAL, INDIRECT, SPECIAL OR INCIDENTAL DAMAGES, EVEN IF PROVIDER HAS BEEN ADVISED BY "USER" OF THE POSSIBILITY OF SUCH POTENTIAL LOSS OR DAMAGE. "USER" AGREES TO HOLD PROVIDER HARMLESS FROM AND AGAINST ANY AND ALL CLAIMS, LOSSES, LIABILITIES AND EXPENSES.