WklTimerTasks
WklTimerTasks class
Signature
Dim myWklTimerTasks As WklTimerTasks
Summary
The tasks of a WklTimerList; For Each walks them in the order they were added.
Parameters
None
Remarks
Not created directly; returned by other members of the library.
Code example
None
Inheritance
None
Item property
Signature
Property Get Item(ByVal Index As Variant) As WklTimerTask
Summary
Gets a task by key or position.
Parameters
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
Index | Variant | No | – | The key (without regard to case) or the position from 0. |
Property value: `WklTimerTask` – The task.
Remarks
Default member: it can be left out, as in myWklTimerTasks(...) for myWklTimerTasks.Item(...). Read-only.
Code example
None
Inheritance
Declared by WklTimerTasks.
Count property
Signature
Property Get Count() As Long
Summary
Gets the number of tasks.
Parameters
None
Property value: Long – The number of tasks.
Remarks
Read-only.
Code example
None
Inheritance
Declared by WklTimerTasks.
Add method
Signature
Function Add(ByVal Key As String, Optional ByVal Kind As WklTimerTaskKind = wttEvent) As WklTimerTask
Summary
Adds a task.
Parameters
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
Key | String | No | – | A unique key, compared without regard to case. |
Kind | `WklTimerTaskKind` | Yes | wttEvent | The kind of work (default wttEvent). |
Return value: `WklTimerTask` – The new task.
Remarks
A kind that is not available in this version is refused with wkeNotAvailable.
Code example
None
Inheritance
Declared by WklTimerTasks.
Remove method
Signature
Sub Remove(ByVal Index As Variant)
Summary
Removes a task; its web requests are canceled without events.
Parameters
| Name | Type | Optional | Default | Description |
|---|---|---|---|---|
Index | Variant | No | – | The key or the position from 0. |
Remarks
None
Code example
None
Inheritance
Declared by WklTimerTasks.
Clear method
Signature
Sub Clear()
Summary
Removes all tasks.
Parameters
None
Remarks
None
Code example
None
Inheritance
Declared by WklTimerTasks.