Home >	Contents >	Index >

Expanded TOC   |    Accordion TOC   |    Annotated TOC   |    Index

ICS.RegisterList

Registers an IList by name with Sites.

Syntax

public boolean 
RegisterList(String listname,
             IList ilist)

Parameters

listname

The name that Sites will use to refer to this list.

IList

The IList to be registered.

Description

The RegisterList method registers an IList by name with Sites. The registration of the IList persists only for the duration of the current page evaluation. The registered name of the IList is not persistent across page requests. Once registered, the IList can be referenced from an XML tag or by using the GetList() method.

If the supplied name is in use in the current scope, this list will replace the existing list object. If the value of the IList parameter is null, the specified list will be unregistered.

Note that any IList created by Sites is already registered. This method is primarily used to register instances of new IList types implemented by the user. If Sites is to manipulate these lists created by new implementations of the interface, the name of the list must be registered with Sites first.

Returns

Boolean value indicating the list item was added. An error will be returned if the added list is empty (no rows) or invalid (no columns).

Error Numbers

Use GetErrno() to view the error number.

Example

The following example registers an IList with Sites:

String idVal = "10";  
ics.SetVar("id", idVal);
StringBuffer bf = new StringBuffer();
IList ads = ics.SelectTo("NewPortalImage",
                         "urlpicture,href,alttext", "id", null, 
                         1, "imagelist", true, bf);
ics.ClearErrno();
ics.RegisterList("image", ads);
int listErr = ics.GetErrno();

See Also

CopyList , GetList , RenameList

 

		Home >	Contents >	Index >
	Oracle JAVA Reference Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.