1 # switchview.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name switchview

    14 

    15 ==short-description

    16 

    17 Perform a user interface level view switch.

    18 

    19 ==long-description

    20 

    21 On modern platforms (i.e. more recent than 9.1) does not return until the view switch has completed. On 9.1 and earlier, returns B<before> the view switch has completed, which may cause problems in scripts.

    22 

    23 Note, application and view identifiers can be found using the L<activeview|activeview> command.

    24 

    25 ==see-also

    26 

    27 L<activeview|activeview>

    28 

    29 ==argument uint app_id

    30 

    31 The identifier of the application that owns the view to be switched to.

    32 

    33 ==argument uint view_id

    34 

    35 The identifier of the view to be switched to.

    36 

    37 ==argument uint custom_message_id optional

    38 

    39 A custom message ID to pass to the activating view.

    40 

    41 ==argument string custom_message optional

    42 

    43 A custom message to pass to the activating view, using the given custom message ID. To send binary data use the fshell escape sequences ^x or ^u.

    44 

    45 

    46 ==copyright

    47 

    48 Copyright (c) 2008-2010 Accenture. All rights reserved.

    49