adTempus API
PreviousUpNext
IServerOptions Interface

The ServerOptions object provides access to various application-wide options used by adTempus.

C++
__interface IServerOptions : IDispatch;
C#
public interface IServerOptions : IDispatch;
Visual Basic
Public Interface IServerOptions
Inherits IDispatch

You can only read an modify server options; you cannot add new server options.

This example uses the ServerOptions to set the default HistoryRetentionOptions and HistoryRetentionLimit for jobs that use the default.

    '
    '
    'theScheduler is a Scheduler object that has already been created elsewhere
    '
    dim options as ServerOptions
    dim opt as ServerOption

    options=theScheduler.GetServerOptions
    opt=options.Item("HistoryScavenger:DefaultRetentionType") '(=HistoryRetentionOptions)
    opt.Value=2 'numeric value for HistoryRetentionOptionsEnum.hrRetainXDays
    
    opt=options.Item("HistoryScavenger:DefaultRetentionInterval") '(=HistoryRetentionLimit)
    opt.Value=15 'retain for 15 days
    
    options.Save 'be sure to save the new settings
adTempus API Reference version 3.0.0.0, revised 10/30/2008