nca_step_begin

Session Functions

Indicates the beginning of a set of nca_java_action calls to send to the server as one packet.

void nca_step_begin( );

The nca_step_begin function prevents the sending of data to the NCA server until the script encounters an nca_step_end function. This enables the script to send a set of nca_java_action calls (and other nca_java functions) as one packet.

This function is useful for cases in which the server expects to receive several nca_java_action calls as one packet. If the nca_java_actions are received individually, the server rejects the communication and script replay fails.

The nca_step_begin and nca_step_end functions cannot be nested.

This function can be manually entered and can also be generated automatically during code generation:

  • When entering this function manually, find the appropriate points in the script to add this (and the nca_step_end) function. You can locate the correct points by analyzing the recording log for the NCA protocol (nca_record.log). Search for the string nca_java_action and determine which steps appear in the log without a Client terminate message between them. These steps should be surrounded by the nca_step_begin and nca_step_end functions.

    When entering the nca_step_begin function manually, other nca calls in addition to nca_java_action can be specified between the nca_step_begin and nca _step_end functions. These other nca functions are also sent to the server as a single packet.

  • When this function is added during code generation, VuGen checks which nca_java_action calls were generated by analyzing a portion of the data sent by the client. VuGen then wraps the nca_java_action calls with nca_step_begin and nca_step_end functions. The nca_step_begin and nca_step_end functions are always generated if several nca_java_actions are generated during single data packet analyzing.

    When the nca_step_begin function is generated automatically, nca calls, in addition to nca_java_action, are included between the nca_step_begin and nca _step_end functions and are sent to the server as a single packet.

Return Values

No value returned.

Parameterization

Parameterization is not available for this function.

Example

In the following example, the nca_step_begin function indicates the beginning of the two nca_java_action calls to send to the server as a single packet.

...

nca_set_window("Note");
nca_popup_message_press("Note", "OK");
nca_set_window("Universal Work Queue");
nca_step_begin();
nca_java_action("IEU_HGRID_IEU_HGRID_0", "hGridSClick", "P3==String;P2==10011;");
nca_java_action("IEU_HGRID_IEU_HGRID_0", "hGridSClick", "P3==String;P2==10012;");
nca_step_end();
lngTaskCount =0;
intValidTask =0;
...
Example: Below is the corresponding section of output from the nca_record.log: 
Client Message Properties: action=2 handlerClassId=0x10F handlerId=303
    property=398 type=0xE008 value=Message

    Sub Message Properties: action=2 handlerClassId=0x10F handlerId=303
        property=399 type=0x4000 value="hGridSClick"
        property=400 type=0x4000 value="P3"
        property=401 type=0x4000 value="String"
        property=400 type=0x4000 value="P2"
        property=401 type=0x4000 value="10011"

Client Message Properties: action=2 handlerClassId=0x10F handlerId=303
    property=398 type=0xE008 value=Message

    Sub Message Properties: action=2 handlerClassId=0x10F handlerId=303
        property=399 type=0x4000 value="hGridSClick"
        property=400 type=0x4000 value="P3"
        property=401 type=0x4000 value="String"
        property=400 type=0x4000 value="P2"
        property=401 type=0x4000 value="10012"