Timeout Property
This property specifies a timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout); Unicode (Windows) INT GetTimeout(INT iConnectionId);
INT SetTimeout(INT iConnectionId, INT iTimeout);
#define PID_BTDAEMON_TIMEOUT 16 IPWORKSBT_EXTERNAL void* IPWORKSBT_CALL IPWorksBT_BTDaemon_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKSBT_EXTERNAL int IPWORKSBT_CALL IPWorksBT_BTDaemon_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal); IPWORKSBT_EXTERNAL int IPWORKSBT_CALL IPWorksBT_BTDaemon_CheckIndex(void *lpObj, int propid, int arridx);
Default Value
0
Remarks
This property specifies a timeout for the class.
If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 0 (asynchronous operation).
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
Integer