---
title: "API commands of Simple Scheduler"
canonical: "https://docs.cuesystem.com/space/CVCAPPLETS/441253889/API%20commands%20of%20Simple%20Scheduler"
format: markdown
---
> Macro (toc)

---

# EnableEvent

This function enables the generation of the *eventnumber *event. The function returns true on success or false if an error occurs (*eventnumber* is out of range 1 - 10).

#### Syntax

```visualbasic
Function EnableEvent (eventnumber As Long) As Boolean
```

# DisableEvent 

This function disables generation of the *eventnumber* event.The function returns true on success or false if an error occurs (*eventnumber* is out of range 1 – 10).

#### Syntax

```visualbasic
Function DisableEvent (eventnumber As Long) As Boolean
```

# IsEventEnabled

The function returns whether the *eventnumber* event is enabled (true) or not (false).

#### Syntax

```visualbasic
Function IsEventEnabled (eventnumber As Long) As Boolean
```

# EnableScheduler

This function enables the whole SimpleScheduler (all enabled events will be generated).

#### Syntax

```visualbasic
Function EnableScheduler ()
```

# DisableScheduler

This function disables the whole SimpleScheduler (the generation of all events will be stopped).

#### Syntax

```visualbasic
Function DisableScheduler ()
```

# IsSchedulerEnabled

The function returns whether the whole SimpleScheduler is enabled (true) or not (false).

#### Syntax

```visualbasic
Function IsSchedulerEnabled () As Boolean
```

# SetEventParameters

This function sets new parameters *neweventstarttime* and *neweventperiod* of the *eventnumber *event. *neweventperiod* is rounded to a whole minute and it is set to one minute in case that the *neweventperiod *is smaller than one minute. The function returns true on success or false if an error occurs (*eventnumber* is out of range 1 – 10).

#### Syntax

```visualbasic
Function SetEventParameters (
  eventnumber As Long, 
  neweventstarttime As Time, 
  neweventperiod As Time) 
As Boolean
```

# GetEventParameters

This function returns *eventstarttime* and *eventperiod* of event *eventnumber *as ByRef parameters. The function returns true on success or false if an error occurs (*eventnumber* is out of range 1 – 10).

#### Syntax

```visualbasic
Function GetEventParameters (
  eventnumber As Long, 
  ByRef eventstarttime As Time, 
  ByRef eventperiod As Time) 
As Boolean
```

# SetEventName

This function sets the name of the event *eventnumber* to *neweventname*. The function returns true on success or false if an error occurs (*eventnumber* is out of range 1 – 10).

#### Syntax

```visualbasic
Function SetEventName (
  eventnumber As Long, 
  neweventname As Text) 
As Boolean
```

# GetEventName

This function returns AddressOf Text of the event *eventnumber* name in ByRef parameter *eventname*. The function returns true on success or false if an error occurs (*eventnumber* is out of range 1 – 10).

#### Syntax

```visualbasic
Function GetEventName (
  eventnumber As Long, 
  ByRef eventname As AddressOf Text) 
As Boolean
```