of_register


pfcapsrv.pbl   >   pfc_n_cst_dwcache   >   of_register   

Full name pfc_n_cst_dwcache.of_register
Access public
Extend of integer
Return value integer
Prototype public function integer of_register(string,string,n_tr,any[20],boolean)

Name Datatype
No Data

Name Datatype
lb_initialload boolean
lds_control datastore
ldw_control datawindow
lpo_obj powerobject[]
ls_importfile string
ls_sql string

public function integer of_register (string as_id, string as_dwobjectname, n_tr atr_obj, any aa_args[20], boolean ab_initialload);//////////////////////////////////////////////////////////////////////////////
//
//	Function:  of_Register
//
//	Access:  public
//
//	Arguments:
//	as_id					The ID to be given to this Cache Object.
//	as_dwobjectname	The DataWindow Object to be used on the Cache Object.
//	atr_obj				The Transaction to be used to load the data from a DB.
//	aa_args[20]			The arguments to be used while retrieving from the DB.
//	ab_initialload		Perform an initial load of the data.
//
//	Returns:  integer
//	1 successful.
//	0 already registered.
//	-1 error.
//	-2 error on the transaction object.
// -3 error on the retrieve process.
//
//	Description:
//	Registers the object into the service.
// The data to be cached is found on a DataBase.  A retrive will be performed
// to load the data.   Notice that DataWindow can have arguments.
// The of_Refresh() functions can be used to refresh the data on demand. 
//
//////////////////////////////////////////////////////////////////////////////
//
//	Revision History
//
//	Version
//	6.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.
//
//////////////////////////////////////////////////////////////////////////////

string 		ls_importfile
string		ls_sql
boolean		lb_initialload=True
datawindow	ldw_control
powerobject lpo_obj[]
datastore	lds_control

Return  of_Register (RETRIEVE, ab_initialload, as_id, &
							as_dwobjectname, atr_obj, aa_args, &
							lpo_obj, ldw_control, lds_control, ls_importfile, ls_sql)
end function

     
Name Owner
No Data

     
Name Owner
pfc_n_cst_dwcache.of_register pfc_n_cst_dwcache

     
Full name
No Data

     
Name Scope
No Data