====== Start_MDIChild function ======


 
==== Description ====
 
 
Executes a specified OpenInsight window (form) as an "MDI Child" window.  MDI Child windows must have an MDI frame as a parent and appears in the frame's MDI Client Area at runtime.
 
 
 
 
==== Syntax ====
 
<code>
InstanceID = Start_MDIChild( WindowID,

                                FrameID,

                                CreateParam,

                                Reserved,

                                Title,

                                AppearanceMode,

                                InitX,

                                InitY,

                                InitWinStruct )
 
</code>
 
 
 
 
==== Parameters ====
 
 
 
 
 
 
 
^Name^Required^Description^
|WindowID|Yes|Name of the child window to execute.  Must be in upper-case.|
|FrameID|Yes|Name of the MDI Frame window that "owns" the new child.  Must be in upper-case.|
|CreateParam|No|Data to pass to the child window's CREATE event.  This data is passed as the "CreateParam" argument when the CREATE event is triggered.|
|Reserved|No|N/A|
|Title|No|The title to appear in the child window's title bar.  Defaults to the title of the child window as it was designed.|
|AppearanceMode|No|Specifies how the child window should be displayed.  Can be one of the following values:\\ \\  \\ \\    0 : Displays in the same way as the currently active\\ \\      : child (this is the default)\\ \\    1 : Normal\\ \\    2 : Minimized\\ \\    3 : Maximized|
|InitX|No|The initial X position of the child in the frame's MDI Client area.|
|InitY|No|The initial Y position of the child in the frame's MDI Client area.|
|InitWinStruct|No|Contains the window structure to use to create the child, overriding the structure identified by the WindowID parameter.|

 

 


 
==== Returns ====
 
 
The Instance ID of the newly created window is returned if successful.  Null is returned if the window fails to start.  The instance ID is usually the same as the passed WindowID, but if the window is flagged as multi-instance then the PS can append a unique number (delimited with an "*" character) to the returned ID to ensure that there are no conflicts with existing windows.
 
 
 
 
==== Errors ====
 
 
In the event of an error the Start_MDIChild function returns null.  Error information may be obtained via the Get_Status function.
 
 
 
 
==== Remarks ====
 
 
The basic structure for a window object is described in the PS_EQUATES and PS_WINDOW_EQUATES insert records.
 
 
 
The window's CREATE event (if any) will be triggered before Start_MDIChild returns.
 
 
 
 
==== Example ====
 
<code>
 


   //// Example - Start a maximized MDI Child window in an MDI Frame, passing //
   ////           an ID to load in the  child's CREATE event.//
   
   Declare Function Start_MDIChild
   $insert msWin_ShowWindow_Equates
   
   CustID  = "A12345"
   ChildID = Start_MDIChild( "CUSTOMER_ENTRY", "MAIN_MDI", CustID, "", "",   
                             SW_SHOWMAXIMIZED$, "", "", "" )

 
 
 

</code>

 
==== See Also ====
 
 
Start_Window function, SYSTEM CREATE method, MDIFRAME property, WINDOW object, WINDOW CREATE event.