Data Structures | Enumerations | Functions

Bookmark Functions

Data Structures

struct  HWAPI_BOOKMARK
 Bookmark definition. More...
struct  HWAPI_BOOKMARK_COLLECTION_PROPS
 Bookmark Properties Definition. More...

Enumerations

enum  HWAPI_DATATYPE {
  HWAPI_DATATYPE_NONE = 0, HWAPI_DATATYPE_BYTE = 1, HWAPI_DATATYPE_WORD = 2, HWAPI_DATATYPE_DWORD = 3,
  HWAPI_DATATYPE_QWORD = 4, HWAPI_DATATYPE_FLOAT = 5, HWAPI_DATATYPE_DOUBLE = 6, HWAPI_DATATYPE_STRING = 7,
  HWAPI_DATATYPE_UNICODE_STRING = 8, HWAPI_DATATYPE_MSDOSDate = 9, HWAPI_DATATYPE_MSDOSTime = 10, HWAPI_DATATYPE_FILETIME = 11,
  HWAPI_DATATYPE_UNIXTIME = 12, HWAPI_DATATYPE_OLEDATETIME = 13, HWAPI_DATATYPE_STRUCTURE = 15, HWAPI_DATATYPE_BLOB = 19,
  HWAPI_DATATYPE_UNIXTIME64 = 20, HWAPI_DATATYPE_CHAR = 22, HWAPI_DATATYPE_WCHAR = 23, HWAPI_DATATYPE_HALFFLOAT = 24
}
 

Bookmark Data Types.

More...

Functions

HWAPI HWAPI_RESULT hwBookmarksAdd (HWDOCUMENT hDocument, HWAPI_BOOKMARK *pBookmark)
 Add a BookmarkAdds a bookmark to a Hex Workshop Document.
HWAPI HWAPI_RESULT hwBookmarksGetCount (HWDOCUMENT hDocument, DWORD *pdwCount)
 Get number of bookmarks.
HWAPI HWAPI_RESULT hwBookmarksGetAt (HWDOCUMENT hDocument, DWORD dwIndex, HWAPI_BOOKMARK *pBookmark)
 Get bookmark at specified index.
HWAPI HWAPI_RESULT hwBookmarksRemoveAt (HWDOCUMENT hDocument, DWORD dwIndex)
 Remove bookmark at specified index.
HWAPI HWAPI_RESULT hwBookmarksClear (HWDOCUMENT hDocument)
 Clear all bookmark entriesClear all bookmark entries for the specified document. Bookmark Properties are not modified.
HWAPI HWAPI_RESULT hwBookmarkCollectionLoad (HWDOCUMENT hDocument, TCHAR *szBookmarkFile)
 Load a bookmark collectionLoads a pre-existing bookmark collection from the file system. If a file name is provided (not a full path), Hex Workshop will attempt to load the bookmarks from the default Bookmark directory.
HWAPI HWAPI_RESULT hwBookmarkCollectionSave (HWDOCUMENT hDocument)
 Save a bookmark collectionSave the bookmarks to disk. This operation will fail if the bookmark collection has never been saved. For new bookmarks, please use hwBookmarkCollectionSaveAs.
HWAPI HWAPI_RESULT hwBookmarkCollectionSaveAs (HWDOCUMENT hDocument, TCHAR *szBookmarkFile)
 Save bookmark collection as specified file.
HWAPI HWAPI_RESULT hwBookmarkCollectionGetProps (HWDOCUMENT hDocument, HWAPI_BOOKMARK_COLLECTION_PROPS *pProps)
 Get bookmark collection propertiesGet the Bookmark collection properties (description, author, and associated structure library).
HWAPI HWAPI_RESULT hwBookmarkCollectionSetProps (HWDOCUMENT hDocument, HWAPI_BOOKMARK_COLLECTION_PROPS *pProps)
 Set bookmark collection propertiesSet the Bookmark collection properties (description, author, and associated structure library).
HWAPI HWAPI_RESULT hwStructureLibraryLoad (HWSESSION hSession, LPCTSTR lpstrFileName)
 Load (or reload) the designated structure library.Load the designated structure library. If the structure library is already loaded, it will be reloaded (removing any structures added from this library). The library is automatically set active.

Enumeration Type Documentation

See also:
HWAPI_BOOKMARK
hwBookmarksAdd
hwBookmarksGetAt
Enumerator:
HWAPI_DATATYPE_NONE 

No Data Type.

HWAPI_DATATYPE_BYTE 

8-bit byte

HWAPI_DATATYPE_WORD 

16-bit word

HWAPI_DATATYPE_DWORD 

32-bit dword

HWAPI_DATATYPE_QWORD 

64-bit qword

HWAPI_DATATYPE_FLOAT 

32-bit float

HWAPI_DATATYPE_DOUBLE 

64 bit double

HWAPI_DATATYPE_STRING 

ASCII string.

HWAPI_DATATYPE_UNICODE_STRING 

Unicode (wchar_t) string.

HWAPI_DATATYPE_MSDOSDate 

16-bit MSDOS date format

HWAPI_DATATYPE_MSDOSTime 

16 bit MSDOS time format

HWAPI_DATATYPE_FILETIME 

64-bit FILETIME time/date format

HWAPI_DATATYPE_UNIXTIME 

32-bit time_t format

HWAPI_DATATYPE_OLEDATETIME 

64-bit OLEDATETIME format

HWAPI_DATATYPE_STRUCTURE 

structure definition

HWAPI_DATATYPE_BLOB 

8-bit blob (unexpanded array)

HWAPI_DATATYPE_UNIXTIME64 

64-bit time64_t format

HWAPI_DATATYPE_CHAR 

8-bit char

HWAPI_DATATYPE_WCHAR 

16-bit wchar_t

HWAPI_DATATYPE_HALFFLOAT 

16-bit half precision float (IEEE 754-2008)

Definition at line 366 of file hwapi.h.


Function Documentation

HWAPI HWAPI_RESULT hwBookmarkCollectionGetProps ( HWDOCUMENT  hDocument,
HWAPI_BOOKMARK_COLLECTION_PROPS pProps 
)
Parameters:
hDocument[IN] Hex Workshop document handle
pProps[IN] Bookmark collection properties
Note:
The cbSize value must be initialized in the HWAPI_BOOKMARK_COLLECTION_PROPS
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwBookmarkCollectionLoad ( HWDOCUMENT  hDocument,
TCHAR *  szBookmarkFile 
)
Parameters:
hDocument[IN] Hex Workshop document handle
szBookmarkFile[IN] Bookmark file to load
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwBookmarkCollectionSave ( 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 hwBookmarkCollectionSaveAs ( HWDOCUMENT  hDocument,
TCHAR *  szBookmarkFile 
)
Parameters:
hDocument[IN] Hex Workshop document handle
szBookmarkFile[IN] Bookmark file to save collection as. If a file name is provided (not a full path), Hex Workshop will attempt to save the bookmarks in the default Bookmark directory.
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwBookmarkCollectionSetProps ( HWDOCUMENT  hDocument,
HWAPI_BOOKMARK_COLLECTION_PROPS pProps 
)
Parameters:
hDocument[IN] Hex Workshop document handle
pProps[OUT] Bookmark collection properties
Note:
The cbSize value must be initialized in the HWAPI_BOOKMARK_COLLECTION_PROPS
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwBookmarksAdd ( HWDOCUMENT  hDocument,
HWAPI_BOOKMARK pBookmark 
)
Parameters:
hDocument[IN] Hex Workshop document handle
pBookmark[IN] Pointer to a HWAPI_BOOKMARK containing the bookmark definition
Note:
The cbSize method must be initialized in the HWAPI_BOOKMARK structure.
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwBookmarksClear ( 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 hwBookmarksGetAt ( HWDOCUMENT  hDocument,
DWORD  dwIndex,
HWAPI_BOOKMARK pBookmark 
)
Parameters:
hDocument[IN] Hex Workshop document handle
dwIndex[IN] Bookmark index
pBookmark[OUT] Pointer to a HWAPI_BOOKMARK to be filled with bookmark data.
Note:
The cbSize method must be initialized in the HWAPI_BOOKMARK structure.
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwBookmarksGetCount ( HWDOCUMENT  hDocument,
DWORD *  pdwCount 
)
Parameters:
hDocument[IN] Hex Workshop document handle
pdwCount[OUT] Buffer to place bookmark count
Note:
Bookmark arrays are expanded into multiple bookmarks entries.
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwBookmarksRemoveAt ( HWDOCUMENT  hDocument,
DWORD  dwIndex 
)
Parameters:
hDocument[IN] Hex Workshop document handle
dwIndex[IN] Bookmark index to remove
Returns:
HWAPI_RESULT_SUCCESS on success, otherwise see hwapierr.h for error codes
HWAPI HWAPI_RESULT hwStructureLibraryLoad ( HWSESSION  hSession,
LPCTSTR  lpstrFileName 
)
Parameters:
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.
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