Voice Platform SDK 8.5 API Reference

TScanServer

Description

Scans T-Server for one or more incoming messages for a time interval specified by the parameter timeout. This function does not affect delivery of pending messages and does not process timers, so it should not be used with connections opened in asynchronous mode or if ADDP protocol is used. (Use TScanServerEx() to process timers.)


Top of Page

Parameters

Name Description
server Local server handle to the T-Server in question.
timeout Time interval, in seconds, during which a message from T-Server will be sought.

Top of Page

Return Values

>0 —  Number of received messages.

0 —  The timeout is expired.

-1 —  Error condition. Returned to the application if the request has not been processed due to an incorrect function statement.


Top of Page

Comments

This function does not generate any messages to T-Server.


Top of Page


Send comments on this topic.
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.