hiEnqueueCmd

hiEnqueueCmd(
t_command
[ g_logCommand ]
)
=> t

Description

Adds t_command, which is to be run after returning from the current function and re-entering the event loop, to the command queue.

If the command is required to be replayed, the g_logCommand argument should be specified as a non-nil value. However, in most cases, the command is enqueued by another command that was logged, so it should rarely be necessary to use the g_logCommand argument.

Arguments

t_command	Specifies the command to be executed.
g_logCommand	Causes the command to logged for replay.

Values Returned

t	Always returns t.

Examples

Runs the normalEnqueCmd command in CIW:

procedure(normalEnqueCmd()

    printf("Before Enqueuing Cmd\n")

    hiEnqueueCmd("printf(\"Enqueued Cmd\n\")")

    printf("After Enqueuing Cmd\n")

)

Output when the normalEnqueCmd command is run in CIW. In this case, the enqueued command is run after normalEnqueCmd returns.

   Before Enqueuing Cmd

   After Enqueuing Cmd

   t

   Enqueued Cmd

Runs the enqueCmdwithDBox command in CIW:

procedure(enqueCmdwithDBox()

    printf("Before Enqueuing Cmd\n")

    hiEnqueueCmd("printf(\"Enqueued Cmd\n\")")

    hiDisplayAppDBox(?name 'Testing)

    printf("After Enqueuing Cmd\n")

)

Output when the normalEnqueCmd command is run in CIW. In this case, the enqueued command is run immediately after the dialog box is raised because that is where the event loop is re-entered.

enqueCmdwithDBox()

   Before Enqueuing Cmd

  # Displaying modal dbox "Testing", title "Testing"

  Enqueued Cmd

Related Topics

General Environmental Functions

Return to top