Functions

Editor Manipulation Functions

Functions

HWAPI HWAPI_RESULT hwRefreshView (HWDOCUMENT hDocument)
 Force the editor view to repaintForces Hex Workshop to redraw the editor view with any changes. Hex Workshop automatically refreshes the editor view at the end of a plug-in execution. Redraws can be expensive and care should be used when calling.
HWAPI HWAPI_RESULT hwGetCaretPosition (HWDOCUMENT hDocument, QWORD *pqwOffset)
 Get the editor caret position.
HWAPI HWAPI_RESULT hwSetCaretPosition (HWDOCUMENT hDocument, QWORD qwOffset)
 Set the editor caret position.
HWAPI HWAPI_RESULT hwGetSelection (HWDOCUMENT hDocument, QWORD *pqwLength)
 Get selection length of the hex editor windowThe selection starts at the curret caret position.
HWAPI HWAPI_RESULT hwSetSelection (HWDOCUMENT hDocument, QWORD qwLength)
 Select data within the hex editor windowThe selection starts at the curret caret position.
HWAPI HWND hwGetWindowHandle (HWSESSION hSession)
 Get the window handle of the Hex Workshop frame window.
HWAPI HWAPI_RESULT hwUpdateProgress (HWSESSION hSession, int percentComplete, LPCTSTR status)
 Updates the progress indicator in the Plug-in execute status dialog.The plug-in may call this API to update the status of the plug-in execution. HWAPI_RESULT_USER_ABORT is returned if the user has cancelled the operations.

Function Documentation

HWAPI HWAPI_RESULT hwGetCaretPosition ( HWDOCUMENT  hDocument,
QWORD pqwOffset 
)
Parameters:
hDocument[IN] Hex Workshop document handle
pqwOffset[OUT] Offset address of the editing cursor
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwGetSelection ( HWDOCUMENT  hDocument,
QWORD pqwLength 
)
See also:
hwGetCaretPosition to receive the caret position
Parameters:
hDocument[IN] Hex Workshop document handle
pqwLength[OUT] Length of selection in bytes
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWND hwGetWindowHandle ( HWSESSION  hSession )
Parameters:
hSession[IN] Hex Workshop Plug-in session handle
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwRefreshView ( HWDOCUMENT  hDocument )
Parameters:
hDocument[IN] Hex Workshop document handle
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwSetCaretPosition ( HWDOCUMENT  hDocument,
QWORD  qwOffset 
)
Note:
Selection is cleared on caret position change
Parameters:
hDocument[IN] Hex Workshop document handle
qwOffset[IN] Offset address to place editing cursor
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwSetSelection ( HWDOCUMENT  hDocument,
QWORD  qwLength 
)
See also:
hwSetCaretPosition to adjust the starting offset
Parameters:
hDocument[IN] Hex Workshop document handle
qwLength[IN] Length of selection in bytes
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwUpdateProgress ( HWSESSION  hSession,
int  percentComplete,
LPCTSTR  status 
)
Note:
Call hwUpdateProgess(hSession, -1, NULL) to query for user cancel status without updating the progress indicator.
Parameters:
hSession[IN] Hex Workshop Plug-in session handle
percentComplete[IN] Percent complete (from 0 to 100)
status[IN] Short string to be placed in status dialog
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes

Copyright © 2010 BreakPoint Software, Inc. All Right Reserved.
Generated on Sat Jan 1 2011 07:53:51 for Hex Workshop Plug-in API by doxygen 1.7.2