Interface ITcFileAccessAsync
Asynchronous access to file operations. This interface extends ITcFileAccess.
Syntax
TCOM_DECL_INTERFACE("C04AC244-C126-466E-982E-93EC571F2277", ITcFileAccessAsync) struct __declspec(novtable) ITcFileAccessAsync: public ITcFileAccess Required include: TcFileAccessInterfaces.h
Methods
Interface parameters
Name | Description |
|---|---|
PID_TcFileAccessAsyncSegmentSize | Size of the segments transferred to system service. |
PID_TcFileAccessAsyncTimeoutMs | Sets the timeout in [ms]. |
PID_TcFileAccessAsyncNetId(Str) | NetId of the system service to be contacted. |
Comments
Interface can be obtained from module instance with class ID CID_TcFileAccessAsync.
When using the asynchronous interface, the interface methods inherited from the synchronous variant return ADS_E_PENDING if a query has been successfully submitted but not yet completed. If the call is received while the previous request was still being processed, the error code ADS_E_BUSY is returned.
Description of the module parameters:
- PID_TcFileAccessAsyncAdsProvider: Object ID of a task that provides the ADS interface.
- PID_TcFileAccessAsyncNetId / PID_TcFileAccessAsyncNetIdStr: AmsNetId of the system service used for file access. The "Str" variant takes the AmsNetId as string. Please use one.
- PID_TcFileAccessAsyncTimeoutMs: Timeout for file access.
- PID_TcFileAccessAsyncSegmentSize: The read and write access to file is fragmented with this segment size.