|
of_setrefreshrate
|
|
Full name
|
pfc_n_cst_winsrv_statusbar.of_setrefreshrate
|
Access
|
public
|
Extend of
|
integer
|
Return value
|
integer
|
Prototype
|
public function integer of_setrefreshrate(integer)
|
public function integer of_setrefreshrate (integer ai_seconds);//////////////////////////////////////////////////////////////////////////////
//
// Function: of_SetRefreshRate
//
// Access: Public
//
// Arguments:
// ai_seconds The new Refresh Rate in seconds.
//
// Returns: Integer
// 1 if it succeeds and -1 if an error occurs.
//
// Description:
// Sets a new Refresh Rate for the GUI Status Bar.
//
//////////////////////////////////////////////////////////////////////////////
//
// 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.
//
//////////////////////////////////////////////////////////////////////////////
// Check arguments.
If IsNull(ai_seconds) or ai_seconds < 0 Then
Return -1
End If
// Ret the new rate.
ii_refreshrate = ai_seconds
// Notify the GUI of a new value.
If IsValid(iw_statusbar) Then
iw_statusbar.of_SetRefreshRate(ii_refreshrate)
End If
Return 1
end function