2.2.4.30.1 Note::Create

Create

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include

Description

Create a new Notes window.

Syntax

BOOL Create( int nOption = CREATE_VISIBLE, LPCSTR lpcszFilePathName = NULL )

Parameters

nOption: [input]Standard Origin window create options including; CREATE_VISIBLE - creates a visible Notes page (window); CREATE_HIDDEN - creates a hidden Notes page
lpcszFilePathName: [input]Optional full path and name of the text file to load into the new Notes page. If NULL, an empty page is created.

Return

Returns TRUE on successful exit and FALSE on failure.

Examples

EX1

int Note_Create_ex1()
{
    Note note; 
    note.Create();            // Create a new empty Notes window
    if( note.IsValid() )
    {
        note.Text = "This is a bunch of text\nI want to write out to an\nOrigin Note window.";
    }
    return 0;
}