B_SetServiceTimeout

Note: For backward compatibility with products earlier than extend 10, use the B$ prefix to call the function, instead of B_. From extend 10 onwards, B$ is deprecated.

This function allows the service program to control the length of time that the service program is permitted to run without interacting with BIS.

The service timer is reset when:

The service program is started.
The service program calls any B_ function.

If the timer elapses, the service program is terminated. The default service timeout interval is 30 seconds.

The syntax of this function call is:

Call "B_SetServiceTimeout" using TimeoutInSeconds giving BIS-Status.

where TimeoutInSeconds may be:

The actual number of seconds allowed between calls to BIS B_ functions. Note that the value may range from 10 to 3600 seconds (1 hour). All values out of this range other than 0 are treated as if -1 was specified.
0 to restart the service timer without changing the number of seconds allowed between calls to B_ functions.
-1 to reset the timeout value to the default value of 30 seconds.

The BIS-Status result field and the result codes are defined in BISDEF.CPY. Here are the most common return codes:

BIS-Status Code	Event Description
`BIS-Success`	The call was successful.
`BIS-Fail-SessionAbandoned`	Service termination is already being requested because the BIS session inactivity time has elapsed without a request. This function call had no effect.
`BIS-Fail-SessionComplete`	Service termination is already being requested because a `SessionComplete` tag was rendered. This function call had no effect.
`BIS-Fail-ServiceComplete`	Service termination is already being requested because a `StopService` tag was rendered. This function call had no effect.