Timeout Property

How long vault events may execute before timing out. (Windows only).

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;
- (int)timeout;
- (void)setTimeout:(int)newTimeout;
#define PID_CBDRIVE_TIMEOUT 36

CBFSSTORAGE_EXTERNAL void* CBFSSTORAGE_CALL CBFSStorage_CBDrive_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CBFSSTORAGE_EXTERNAL int CBFSSTORAGE_CALL CBFSStorage_CBDrive_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

0

Remarks

When an application is operating in Callback Mode, this property specifies how long the Vault* events may execute before timing out.

When this property is set to a non-zero value, and a Vault* event executes long enough for its timeout to expire, the driver cancels the underlying request by reporting an error to the OS. The tardy event still runs to completion, but any results it returns once finished are ignored since the underlying request has already been handled.

Setting this property to 0 disables event timeouts, which allows Vault* events to take as long as necessary to execute.

Note: This property cannot be changed within events.

Data Type

Integer

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 C++ Edition - Version 20.0 [Build 8031]