of_register

pfcapsrv.pbl   >   pfc_n_cst_tvsrv_levelsource   >   of_register

Name	Datatype
lds_control	datastore
ldw_control	datawindow
lpo_obj	powerobject[]
ls_dwobjectname	string
ls_importfile	string
ls_retrieveargs	string
ls_sql	string
ltr_obj	n_tr

public function integer of_register (integer ai_level, string as_labelcolumn, string as_retrieveargs, string as_dwobjectname, powerobject apo_data[], string as_filtercols);//////////////////////////////////////////////////////////////////////////////
//
//	Function:	of_register
//
//	Access:		public
//
//	Arguments:
//	ai_Level				The TreeView level to associate the data source with.
//	as_LabelColumn		The column in the DataWindow object to display. 
//	as_RetrieveArgs	Retrieval/filter arguments for the level.  These should
//								be separated by commas in the format:
//										:keyword.n.column
//								where column is the name of a column in another level's
//								data source.  If keyword is 'level', n is an absolute level 
//								number.  If keyword is 'parent', n is a number relative to
//								the current level (i.e. :parent.2.c1 would be column c1 in
//								the DataWindow for the level 2 levels above this one).
//	as_dwobjectname	The datawindow object to be used for the data source.
//	apo_data				The powerobject object to be used for the data source.
//	as_FilterCols		Columns on the datastore object used for filtering the datastore.
//							This type of datasource does a retrieve once and uses the 
//							retrieval arguments to to filter out those records which do not
//							match.  The column names should be separated by commas.
//								ex:  "colname.NA, Col2name.NO, col3name"
//								means "Not (Colname=xxx) And Not (col2name=xxx) Or col3name=xxx"
//								ex:  "colname.A, Col2name"
//								means "Colname=xxx And col2name=xxx"
//									xxx is the values provided by the retrieval args
//							The columns will be the left side of the filter statement and the
//							retrieval arguments are the right side (i.e. filtercol='retrieval args')
//
//	Returns:  integer
//	 1 = the data source was added successfully
//	-1 = argument validation error
//	-2 = the DataWindow object did not have any key columns assigned
//	-3 = a previous level had already been marked as recursive (there can be no more)
//
//
//	Description:	Register a powerobject (usually an array) as a data source for a level of the TreeView.  
//						The data source will be linked to the TreeView level and used
//						to populate.
//
//////////////////////////////////////////////////////////////////////////////
//
//	Revision History
//
//	Version
//	6.0   Initial version
//
//////////////////////////////////////////////////////////////////////////////
//
//	Copyright © 1996-1997 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.
//
//////////////////////////////////////////////////////////////////////////////

n_tr			ltr_obj
string		ls_dwobjectname
string		ls_retrieveargs
string		ls_sql
powerobject lpo_obj[]
datawindow	ldw_control
datastore	lds_control
string		ls_importfile

// Check Arguments
If IsNull(as_dwobjectname) or Len(Trim(as_dwobjectname))= 0 Then Return -1
If IsNull(apo_data) Then Return -1
If UpperBound(apo_data) = 0 Then Return -1

SetNull(ls_sql)
SetNull(ldw_control)
SetNull(lds_control)
SetNull(ls_importfile)

Return of_register(ai_Level, as_LabelColumn, as_retrieveargs, as_DWobjectname, ltr_obj, as_filtercols, &
				inv_cache.POWEROBJECT, ls_sql, apo_data, ldw_control, lds_control, ls_importfile)

end function

Name	Owner
systemfunctions.isnull	systemfunctions
systemfunctions.len	systemfunctions
systemfunctions.setnull	systemfunctions
systemfunctions.trim	systemfunctions
systemfunctions.upperbound	systemfunctions
pfc_n_cst_tvsrv_levelsource.of_register	pfc_n_cst_tvsrv_levelsource