ListProperty Method for LCSession

This method lets you retrieve information about each of the properties supported by the Session. Information about one property is returned with each call to ListProperty.

Defined In

LCSession Class

Syntax

flag = lcSession.ListProperty(list, propertyToken, dataType, propertyFlags, propertyName)

Parameters


Parameter	Description
list	Long. Constant indicating whether to return the first or next session 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 method for this session).
propertyToken	Long, output. Optional. Token assigned to the property. See Appendix B for a list of tokens
dataType	Long, output. Optional. Data type of the property.
propertyFlags	Long, output. Optional. Property flags for the property. None defined at this time. Value is always zero.
propertyName	String, output. Optional. Name of the property.

Return Value


Value	Description
flag	Boolean. True if information about a property was fetched, False if there were no more properties to list.

Example

Uselsx "*lsxlc"
Option Declare
Sub Initialize
  Dim ses As New Lcsession("Salad")
     ' Must supply session name for scripted activity.
  Dim more As Variant, token As Long, dtype As Long
  Dim flags As Long, pname As String, propFld as LCField
	
  more = ses.Listproperty(LCLIST_FIRST, token, dtype, flags, pname)
  Do While more
    Set propFld = ses.GetProperty(token)
    Print pname & " = " & ses.Getproperty(token).Text(0)
    more = ses.Listproperty(LCLIST_NEXT, token, dtype, flags, pname)
  Loop
End Sub

Example Output

Name = Salad
TextFormat = 82
CharacterSet = IBMCP1252
EventError = 0
IgnoreError = 0