Functions | |
HWAPI HWAPI_RESULT | hwStructureLibraryClose (HWSESSION hSession, LPCTSTR lpstrFileName) |
Close/Unload the specified structure library.Close/Unload the specified library and remove all structures added from this library. | |
HWAPI HWAPI_RESULT | hwStructureLibrarySetActive (HWSESSION hSession, LPCTSTR lpstrFileName) |
Set the active structure librarySets the active structure library. The hwStructureAddFloating, hwStructureAddLocked, and hwStructureExecuteFunction APIs use the active structure library (what is displayed in the Structure Viewer's dropdown box) to lookup structure and function names. Other libraries are not search. | |
HWAPI HWAPI_RESULT | hwStructureLibraryGetActive (HWSESSION hSession, LPTSTR lpstrFileName, size_t nFileName) |
Gets the active structure library.Gets the active structure library and returns the full file path in lpstrFileName. | |
HWAPI HWAPI_RESULT | hwStructureRemoveAll (HWSESSION hSession) |
Removes all structures displayed in the Structure Viewer.Removes locked and floating structures for all documents. | |
HWAPI HWAPI_RESULT | hwStructureRemoveAllDocument (HWDOCUMENT hDocument) |
Removes all structures locked to the designated document.Removes all structures locked to the designated document. Float structures and structures locked to other documents are not removed. | |
HWAPI HWAPI_RESULT | hwStructureAddFloating (HWSESSION hSession, LPCTSTR lpstrStructureName, HWAPI_BYTEORDER byteOrder) |
Add a floating structureAdds a float structure to the structure viewer control within Hex Workshop. Floating structures are not bound to a document or offset and are re-evaluated on all document focus and caret position changes. | |
HWAPI HWAPI_RESULT | hwStructureAddLocked (HWDOCUMENT hDocument, LPCTSTR lpstrStructureName, QWORD qwOffset, HWAPI_BYTEORDER byteOrder) |
Adds a locked structureAdds a structure to a document at a specific offset. The structure is displayed in the structure viewer control within Hex Workshop. | |
HWAPI HWAPI_RESULT | hwStructureExecuteFunction (HWDOCUMENT hDocument, LPCTSTR lpstrFunctionName, HWAPI_BYTEORDER byteOrder) |
Execute a function within a structure library. |
HWAPI HWAPI_RESULT hwStructureAddFloating | ( | HWSESSION | hSession, |
LPCTSTR | lpstrStructureName, | ||
HWAPI_BYTEORDER | byteOrder | ||
) |
hSession | [IN] Hex Workshop Plug-in session handle |
lpstrStructureName | [IN] The name of the structure that should be added. |
byteOrder | [IN] The desired byte order that should be used during structure parsing/rendering. If the structure library declares a byte order, that byte order is used and this parameter is ignored. |
HWAPI HWAPI_RESULT hwStructureAddLocked | ( | HWDOCUMENT | hDocument, |
LPCTSTR | lpstrStructureName, | ||
QWORD | qwOffset, | ||
HWAPI_BYTEORDER | byteOrder | ||
) |
hDocument | [IN] Hex Workshop document handle |
lpstrStructureName | [IN] The name of the structure that should be added. |
qwOffset | [IN] The offset to place the locked structure. |
byteOrder | [IN] The desired byte order that should be used during structure parsing/rendering. If the structure library declares a byte order, that byte order is used and this parameter is ignored. |
HWAPI HWAPI_RESULT hwStructureExecuteFunction | ( | HWDOCUMENT | hDocument, |
LPCTSTR | lpstrFunctionName, | ||
HWAPI_BYTEORDER | byteOrder | ||
) |
hDocument | [IN] Hex Workshop document handle |
lpstrFunctionName | [IN] The name of the function that should be executed. |
byteOrder | [IN] The desired byte order that should be used during function parsing/evaluation. If the structure library declares a byte order, that byte order is used and this parameter is ignored. |
HWAPI HWAPI_RESULT hwStructureLibraryClose | ( | HWSESSION | hSession, |
LPCTSTR | lpstrFileName | ||
) |
hSession | [IN] Hex Workshop Plug-in session handle |
lpstrFileName | [IN] Filename or path to structure library. If only a file name is provided (not a full path), Hex Workshop will expand the path to match the default Structure directory. |
HWAPI HWAPI_RESULT hwStructureLibraryGetActive | ( | HWSESSION | hSession, |
LPTSTR | lpstrFileName, | ||
size_t | nFileName | ||
) |
hSession | [IN] Hex Workshop Plug-in session handle |
lpstrFileName | [OUT] Buffer to place the active structure library. The full path to the structure library is always returned. |
nFileName | [IN] The size of the lpstrFileName buffer in TCHARs. IF the supplied buffer is too small, the API will return HWAPI_RESULT_BUFFER_TOO_SMALL. |
HWAPI HWAPI_RESULT hwStructureLibrarySetActive | ( | HWSESSION | hSession, |
LPCTSTR | lpstrFileName | ||
) |
hSession | [IN] Hex Workshop Plug-in session handle |
lpstrFileName | [IN] Filename or path to structure library. If only a file name is provided (not a full path), Hex Workshop will expand the path to match the default Structure directory. |
HWAPI HWAPI_RESULT hwStructureRemoveAll | ( | HWSESSION | hSession ) |
hSession | [IN] Hex Workshop Plug-in session handle |
HWAPI HWAPI_RESULT hwStructureRemoveAllDocument | ( | HWDOCUMENT | hDocument ) |
hDocument | [IN] Hex Workshop document handle |