bool Destroy_Bookmark(BAR_Bookmark Bookmark);

Parameters

BAR_Bookmark Count: A node bookmark.

Return Values

• True: Successful bookmark destruction.
• False: Unsuccessful bookmark destruction.

Remarks

Some builds of BAR require that you explicitly destroy node bookmarks (they are not destroyed when the declared type goes out of scope).  For such builds as C++ LIB, call Destroy_Bookmark to explicitly destroy a bookmark, which frees memory taken up by the bookmark.  This function is not available in all builds of the BAR engine.

A bookmark is always destroyed automatically when unloading a file (Unload or Destroy called).

This function fails if no file was loaded or if Bookmark does not represent a valid bookmark.

Compatibility

	All Platforms	Win32 C++ LIB
BAR version	X	1.1
	All Platforms	Win32
BARfly version	n/a	n/a

  See also:  [BAR type lookup functions] [BAR loading and saving functions] [BAR node navigation functions]
[BAR node information functions] [BAR data reading functions] [BAR data writing functions] [BAR miscellaneous functions]