ListProperty Method for LCConnection

This method obtains the first or next property information for properties supported by this connector.

Defined In

LCConnection

Syntax

result = lcConnection.listProperty (list, propertyToken, dataType, propertyFlags, propertyName)

Parameters


Parameter	Description
list	Long. Constant indicating whether to return the first or next connector property.
	LCLIST_FIRST: Return the first property in the property list.
	LCLIST_NEXT: Return the next property (or the first property if this is the first call to this function for this Connection).
propertyToken	Long. Output, optional. Token assigned to the property.
dataType	Long. Output, optional. Data type of the property.
propertyFlags	Long. Output, optional. Property flags for the property; one or more of the flags mentioned ORed together.
	LCPROPERTYF_CONNECT: Property is used for connecting
	LCPROPERTYF_BOOLEAN: Property is a boolean value
	LCPROPERTYF_READONLY: Property is read-only
	LCPROPERTYF_TEXTLIST: Property is a text list
PropertyName	String. Output, optional. Name of the property.

Return Value


Value	Description
result	Boolean. TRUE if property information was returned, or FALSE if there are no more properties to list.

Example

Option Public
Uselsx "*lsxlc" 

Sub Initialize
  Dim connect As New LCConnection ("oracle") 
  Dim conFld As LCField
  Dim propName As String
  Dim tokenId As Long
  Dim propType As Long
  Dim propFlags As Long

  ' set some connector properties
  connect.Server = "Rainbow"
  connect.Userid = "JDoe"
  connect.Password = "xyzzy"
  connect.Metadata = "scott.bigtable"
  connect.FieldNames = "name, address, city, state, zipcode, phone"

  Print "NAME" Tab(20); "ID"; Tab(26); "FLAGS"; _
  Tab(32); "TYPE"; Tab(38); "VALUE"
  Print "-----------------" Tab(20); "-----"; Tab(26); "-----"; _
  Tab(32); "----"; Tab(38); "------------"

  ' all of the parameters are optional and any may be omitted
  Call connect.ListProperty (LCLIST_FIRST,_
  tokenId, propType, propFlags, propName)
  Do
    Set conFld = connect.GetProperty (tokenId)
    Print propName; Tab(20); Hex(tokenId); Tab(27); Hex(propFlags); _
    Tab(32); propType; Tab(38); conFld.Text(0)
    Loop While connect.ListProperty (LCLIST_NEXT, _
  tokenId, propType, propFlags, propName)
End Sub

Example Output

NAME               ID    FLAGS TYPE  VALUE
-----------------  ----- ----- ----  ------------
Name               30004  4     6    oracle
IsConnected        3000C  6     1    0
Server             10001  1     6    mycyclone
Userid             10003  1     6    scott
Password           10004  1     7  
Metadata           10005  0     6    scott.bigtable
Index              10006  0     6  
MapByName          10007  2     1    0
Writeback          10008  2     1    0
OrderNames         1000A  8     7  
FieldNames         10009  8     7    name, address, city, state, zipcode, phone
Condition          1000B  0     6  
StampField         1000C  0     6  
BaseStamp          1000D  0     5  
MaxStamp           1000E  0     5  
TextFormat         1000F  4     1    65535
CharacterSet       30008  4     6    NATIVE
Procedure          10010  0     6  
Owner              10011  0     6  
AlternateMetadata  10013  2     1    0
CommitFrequency    1      0     1    0
RollbackOnError    2      2     1    0
CreateLongColumn   3      0     6  
CreateLongByUser   4      0     1    0
TraceSQL           5      2     1    0