Salesforce

RqRtTrmEx (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

RqRtTrmEx (Magic xpa 4.x)

Terminates all enterprise servers associated with a requester by a graceful termination.

Syntax:

RqRtTrmEx(service name, entry number, supervisor password, graceful timeout)

Parameters:

service name: An Alpha variable or constant with a service name.

entry number: Numeric values indicating the internal number of the runtime engine in the list returned by the RqRts function. If the value is 0, all runtime engines will be terminated.

supervisor password: An Alpha variable defining the supervisor password specified of the Service Broker.

graceful timeout: The number of seconds until the server engine is terminated after the function is executed.

Returns:

True when the enterprise server has been terminated.
False is returned when the enterprise server has not been terminated.

Example:

RqRtTrmEx('Data Server', BA, 'Secret', 900) The virtual numeric variable BA temporarily stores the entry number. This number is returned from the execution of the RqRts function.

Exception:

This function is supported only while using the Broker as a middleware.

Note:

You must run the RqRts function before using this function.

An invalid service name or runtime engine number causes the function to fail. If another password is used, other than the supervisor password, the function fails. When the Graceful Timeout parameter is not set or not a valid value, the default timeout value will be zero.

See also:

RqRtTrm

The Online and Rich Client Samples projects (program ES11 and RES11)

Reference
Attachment 
Attachment