 Oracle Scheduler Control Help Index

Properties

ConsoleTime	BSTR

The time to add to the /GMT if timezone is Console. Syntax is "+x.x"            "-x.x",exact string will be appended to the /GMT keyword when outputting schedule String.

EnableDuration	BOOL

Map or Unmap the duration button on control, from which the Duration Dialog is brought up.

OracleNLSLang	BSTR

The Oracle NLS string converted from the Oracle Locale ID. This is used to determine which resource dll to load in. An alternative to setting this property is to set the Locale ID Ambient property.

ScheduleMode	SHORT

Read-only Property, returns the current Scheduler Execution Mode specified by the UI.

Methods

SetDuration (short days, short hours, short mins)

Sets the duration values for the control, these values will show up when Duration Dialog is shown. All values must be positive.

Max Duration Days -- UB2_MAXVAL

Max Duration Hours -- 99

Max Duration Mins -- 59

Possible Error Code:

SCHEDCTL_E_DURATION_OUT_OF_RANGE

VT_EMPTY GetDuration (short FAR* pDays, short FAR* pHours, short FAR* pMins)

Gets the current duration values.

VT_BOOL SetScheduleString (VTS_BSTR ScheduleString)

Sets the UI to shown the modes, times and intervals as specified by the ScheduleString. Returns FALSE if string is invalid. Validation is done on the string and validated according to the grammar outlined by the original spec.

Possible Error Codes:

SCHEDCTL_E_INVALID_MODE -- Execution mode invalid or not found

SCHEDCTL_E_INVALID_FREQUENCY -- Frequency clause invalid or not found.

SCHEDCTL_E_INVALID_INTERVAL -- Interval values out of range

SCHEDCTL_E_INVALID_DAYOFWEEK -- Day of week values invalid.

SCHEDCTL_E_INVALID_DAYOFMONTH -- Day of month values invalid.

SCHEDCTL_E_INVALID_STARTDATE -- Start Time or Start Date Invalid or not found.

SCHEDCTL_E_INVALID_ENDDATE -- End Date or End Time Invalid or not found,  or End        	          time preceeds start time.

VT_BOOL GetScheduleString (BSTR FAR* pScheduleString)

Returns the Schedule String as specified by the current UI. The string generated is guaranteed to be valid if UI is valid. Returns FALSE if string cannot be generated.

Possible Error Codes;

SCHEDCTL_E_INVALID_DAYOFWEEK -- e.g. No day selected on UI.

SCHEDCTL_E_INVALID_DAYOFMONTH -- e.g.No day selected on UI

SCHEDCTL_E_INVALID_ENDDATE -- End time preceeds start time.

SCHEDCTL_E_INVALID_INTERVAL -- Interval values out of range

VT_BOOL GetNextExecutionTime (LPCTSTR ScheduleString, DATE FAR* pNextExecutionTime)

Validates the ScheduleString and returns the next execution time. The next execution time must not have passed.

Possible Error Codes:

SCHEDCTL_E_EXECUTION_TIME_PASSED -- Execution time has passed.

SCHEDCTL_E_INVALID_MODE -- Execution mode invalid or not found

SCHEDCTL_E_INVALID_FREQUENCY -- Frequency clause invalid or not found.

SCHEDCTL_E_INVALID_INTERVAL -- Interval values out of range

SCHEDCTL_E_INVALID_DAYOFWEEK -- Day of week values invalid.

SCHEDCTL_E_INVALID_DAYOFMONTH -- Day of month values invalid.

SCHEDCTL_E_INVALID_STARTDATE -- Start Time or Start Date Invalid or not found.

SCHEDCTL_E_INVALID_ENDDATE -- End Date or End Time Invalid or not found, or End time preceeds start time.

VT_ERROR GetErrorInfo()

Returns the current error code of the control List of all error codes include:

S_OK -- No error

SCHEDCTL_E_INVALID_MODE

SCHEDCTL_E_INVALID_FREQUENCY

SCHEDCTL_E_INVALID_INTERVAL

SCHEDCTL_E_INVALID_DAYOFWEEK

SCHEDCTL_E_INVALID_DAYOFMONTH

SCHEDCTL_E_INVALID_STARTDATE

SCHEDCTL_E_INVALID_ENDDATE

SCHEDCTL_E_DURATION_OUT_OF_RANGE

SCHEDCTL_E_EXECUTION_TIME_PASSED

\


No Help Available

No help is available for this area of the window.


No Help Available

No help is available for this message box.

<< If you wish to author help specific to each message box prompt, then remove the AFX_HIDP_xxx values from the [ALIAS] section of your .HPJ file, and author a topic for each AFX_HIDP_xxx value.  For example, AFX_HIDP_INVALID_FILENAME is the help topic for the Invalid Filename message box. >>