Function : Note

NSFNoteOpen - Opens a note.
----------------------------------------------------------------------------------------------------------

#include <nsfnote.h>

STATUS LNPUBLIC NSFNoteOpen(
DBHANDLE db_handle,
NOTEID note_id,
WORD open_flags,
NOTEHANDLE far *note_handle);

Description :

This function reads a note into memory and returns a handle to the in-memory copy. Its input is a database handle and a note ID within that database. This function only supports the set of 16-bit WORD options described in the entry OPEN_xxx; to use the extended 32-bit DWORD options, use the function NSFNoteOpenExt().

If the note is marked as unread, by default this function does not change the unread mark. You can use the OPEN_MARK_READ flag to change an unread mark to read for remote databases.

Use NSFNoteClose to close the note handle and deallocate the memory associated with it.

Parameters :

Sample Usage :


  /* Reopen the Note and examine its contents */
  if (error_status = NSFNoteOpen(db_handle, note1_id,
                                 0, &note1_handle))
      goto Exit;
  else
      cleanup_state += CLOSE_NOTE1;


See Also :

NSFNoteClose
----------------------------------------------------------------------------------------------------------