(Engine-Level Function)
| Description: | Adds a note to a notebook tag |
| Returns: | Nothing |
Usage:  |
Script Only. |
| Function Groups: | Log |
| Related to: | |
| Format: |
NotebookTagObject.AddNote(TimeStamp, Operator, Note, [ResultPtr, AccountID, Parent, LegacyConvert]) |
| Parameters: |
| Timestamp |
| Required UTC timestamp of the note. |
| Operator |
| Deprecated text. Only use this when converting legacy notes. The name of the user who entered the note. |
| Note |
| Required. A text string containing the note or a NoteStruct structure. |
| ResultPtr |
| Optional. This pointer will be assigned TRUE if the note is added successfully, FALSE if it fails. |
| AccountID |
| Optional string. The AccountID of the user who entered the note. Defaults to the user who opened the dialog. |
| ParentNoteStruct |
| Optional structure. If the note is a comment for another note, this must be set to the NoteStruct structure of the other note. |
| LegacyConvert |
| Optional boolean. Set to TRUE when converting legacy notes. Defaults to FALSE. |
| Comments: |
NotebookTagObject must be the object value of the Notebook tag you wish to add a note to. This interface is not intended as a means of logging frequent string values. It was designed for occasional notes entered by people. |
Example:
NotebookTagObject.AddNote(CurrentTime(1), Invalid, "Hello world", &Result);
