|
of_settimerinterval
|
|
Full name
|
pfc_n_cst_winsrv_statusbar.of_settimerinterval
|
Access
|
public
|
Extend of
|
integer
|
Return value
|
integer
|
Prototype
|
public function integer of_settimerinterval(long)
|
Name
|
Datatype
|
li_rc
|
Integer
|
public function integer of_settimerinterval (long al_milliseconds);//////////////////////////////////////////////////////////////////////////////
//
// Function: of_SetTimerInterval
//
// Access: Public
//
// Arguments:
// al_milliseconds The new Timer Interval to be used in updating the Timer
// object.
//
// Returns: Integer
// 1 if it succeeds and -1 if an error occurs.
//
// Description:
// Sets the new Timer Interval to be used in updating the Timer
// object (if any has been requested or is later requested).
//
// Note: This only applies to the Pre-Defined Timer object.
//
//////////////////////////////////////////////////////////////////////////////
//
// Revision History
//
// Version
// 5.0 Initial version
//
//////////////////////////////////////////////////////////////////////////////
//
// Copyright © 1996-1999 Sybase, Inc. and its subsidiaries. All rights reserved.
// Any distribution of the PowerBuilder Foundation Classes (PFC)
// source code by other than Sybase, Inc. and its subsidiaries is prohibited.
//
//////////////////////////////////////////////////////////////////////////////
Integer li_rc
// Check arguments.
If IsNull(al_milliseconds) or al_milliseconds <0 Then
Return -1
End If
// Set the timer interval.
il_timerinterval = al_milliseconds
// Notify the GUI of a new value.
If IsValid(iw_statusbar) Then
li_rc = iw_statusbar.of_UpdateDWTimerInterval(al_milliseconds)
End If
Return 1
end function