InkFolderGetNumChildren()

dword 	InkFolderGetNumChildren( /* Subfolders:Notes */
        dword 		fldr, 		/* ID# of folder */
        VMFileHandle 		fh);		/* Handle of Ink DB file */

This message returns the number of children the Ink Database folder has. The high word of the return value holds the number of sub folders; the low word holds the number of notes.

Include: pen.goh

InkFolderMove()

void 	InkFolderMove(
        dword 		fldr, 		/* ID# of folder to move */
        dword 		pfldr);/* ID# of new parent folder */

This routine moves an Ink Database folder to a new location in the folder tree.

Include: pen.goh

InkFolderSetTitle()

void 	InkFolderSetTitle(
        dword 		tag, 		/* ID# of folder */
        VMFileHandle 		fh,		/* Handle of Ink DB file */
        const char *		name); 		/* Text object */);

This routine renames an Ink Database folder. The passed name should be null-terminated.

Include: pen.goh

InkFolderSetTitleFromTextObject()

void 	InkFolderSetTitleFromTextObject(
        dword 		tag, 		/* ID# of folder */
        FileHandle 		fh,		/* Handle of Ink DB file */
        optr		text); 		/* Text object */);

This routine sets the name of the passed Ink Database folder from the contents of the passed VisText object.

Include: pen.goh

InkGetDocPageInfo()

void 	InkGetDocPageInfo(
        PageSizeReport *		psr, 		/* Structure to fill with return value */
        VMFileHandle 		fh);

This routine returns the dword ID of the head folder of an Ink Database file.

Include: pen.goh

InkGetDocCustomGString()

GStateHandle 	InkGetDocCustomGString(
        VMFileHandle 		dbfh);

This routine returns the custom GString associated with the passed Ink Database file. Note that this custom background will only be used if the document's basic InkBackgroundType is IBT_CUSTOM. (This may be determined using the InkSetDocGString() routine.

Include: pen.goh

InkGetDocGString()

InkBackgroundType 	InkGetDocGString(
        VMFileHandle 		dbfh);

This routine returns the standard GString to use as a background picture with the passed Ink Database file. If the returned background type is custom, be sure to also call InkGetDocCustomGString() .

Include: pen.goh

InkGetParentFolder()

dword 	InkGetParentFolder(
        dword 		tag, 		/* ID# of folder or note */
        VMFileHandle 		fh);		/* Handle of Ink DB file */

This message returns the dword ID of the passed Ink Database note or folder.

Include: pen.goh

InkGetTitle()

word 	InkGetTitle(
        dword 		tag, 		/* ID# of folder or note */
        VMFileHandle 		fh,		/* Handle of Ink DB file */
        char *		dest); 		/* should be INK_DB_MAX_TITLE_SIZE +1 */);

This message fills the passed text buffer with the folder's or note's title, a null-terminated string. The routine's explicit return value is the length of the string (including the terminator).

Include: pen.goh

InkNoteCopyMoniker()

dword 	InkNoteCopyMoniker(
        dword 	title,	/* ID# of parent folder */
        optr 	list, 	/* Output list */
        word 	type, 	/* 1: text note
			 * 0: ink note
			 * -1: folder */

        word	entry);	/* Handle of Ink DB file */

This routine copies the icon nd title into the VisMoniker.

Include: pen.goh

InkNoteCreate()

dword 	InkNoteCreate(
        dword 		tag,		/* ID# of parent folder */
        VMFileHandle		fh);		/* Handle of Ink DB file */

This routine creates a note and adds it to the passed folder's child list. The new note's dword ID is returned.

Include: pen.goh

InkNoteCreatePage()

word 	InkNoteCreatePage(
        dword 		tag,		/* ID# of note */
        VMFileHandle		fh,		/* Handle of Ink DB file */
        word 		page); /* Page number to insert before, 
				 * CA_NULL_ELEMENT to append */

This routine creates a new page within a note. It returns the new page number.

Include: pen.goh

InkNoteDelete()

void 	InkNoteDelete(
        dword 		tag, 		/* ID# of note */
        VMFileHandle 		fh);		/* Handle of Ink DB file */

This message deletes the passed note. All references to the note are deleted.

Include: pen.goh

InkNoteFindByKeywords()

ChunkHandle 	InkNoteFindByKeywords( 
/* Return value is chunk array with elements:
 *  FindNoteHeader
 *  -dword tag-
 *  -dword tag-
 *   etc... */

        VMFileHandle 		fh,
        char *		strings,		/* strings to match (separated by 
					* whitespace or commas), can contain
					* C_WILDCARD or C_SINGLE_WILDCARD */

        word 		opt,		/* true to match all keywords; 
				 * false to match at least one keyword */

This routine returns a chunk array containing the dword ID numbers of all notes whose keywords match the passed search string, preceded by the number of matching notes. If no such notes are found, then the returned handle will be NULL.

Note that this routine will only return about 20K notes; if there are more that match, only the first 20K will be returned.

Include: pen.goh

InkNoteFindByTitle()

ChunkHandle 	InkNoteFindByTitle( 
/* Return value is chunk array with elements:
 *  FindNoteHeader
 *  -dword tag-
 *  -dword tag-
 *   etc... */

        const char *		string,		/* string to match (can contain C_WILDCARD
				  * or C_SINGLE_WILDCARD */

        SearchOptions 		opt,		/* Search options */
        Boolean 		Body, 		/* true if you want to look in the body
				 * of text notes */

        VMFileHandle		fh);		/* Handle of Ink DB file */

This routine returns a chunk array containing the dword ID numbers of all notes whose titles match the passed search string, preceded by the number of matching notes. If no such notes are found, then the returned handle will be NULL.

Note that this routine will only return about 20K notes; if there are more that match, only the first 20K will be returned.

Include: pen.goh