PROPLIST.GetSelected

Previous  Next

 

selected = PROPLIST.GetSelected( fid   AS HANDLE,

                                [type  AS INTEGER=PL_TYPE_FILE],

                                [no    AS INTEGER=-1] ) AS INTEGER

 

selected = PROPLIST.GetSelected( nItem AS INTEGER ) AS INTEGER

 


 

The first syntax returns the selected state of files, points or analogs from the File Pane.  If fid is in the range 0x0001-0x0fff then use as file index.

 

Returns No of Points or Analogs if nNo = PL_GetNoOfPoints or PL_GetNoOfAnalogs.  This is the default if parameter is omitted.

Returns No of Files if fid = 0xffffffff and type = Pl_Type_File (Default)

Returns Default Point List if fid = 0xfffffffe and type = PL_Type_Point

Returns Default Analog List if fid = 0xfffffffe and type = PL_Type_Analog

 

The Default Point or Analog lists are type STRING with the following format "point1_name|point_2_name|pointX_name...".  The default strings can be passed to the PROPLIST.AddFile function.

 

Types

CONST PL_GetNoOfFiles      = 0xFFFFFFFF

CONST PL_GetDefaultList    = 0xFFFFFFFE

CONST PL_GetSelectedPane   = 0xFFFFFFFD

CONST PL_GetNoOfPoints     = -1

CONST PL_GetNoOfAnalogs    = -1

CONST PL_Type_File         = 0

CONST PL_Type_Point        = 1

CONST PL_Type_Analog       = 2

 

The second syntax returns the current selected pane or item,

 

CONST PL_Selected_Pane     = 0

CONST PL_Selected_Item     = 1

 

Example:

 

IF ENVIRONMENT = MB_Env_Console THEN

  DIM i AS INTEGER

  DIM j AS INTEGER

 

  FOR i = 1 TO PROPLIST.GETSELECTED( PL_GetNoOfFiles )

     PRINT "File ";i;": ";PROPLIST.GETSELECTED( i ),

 

     FOR j = 1 TO PROPLIST.GETSELECTED( i, PL_Type_Point )

        PRINT "File ";i;"::Point ";j;": ";PROPLIST.GETSELECTED( i, PL_Type_Point, j ),

     ENDFOR

 

     FOR j = 1 TO PROPLIST.GETSELECTED( i, PL_Type_Analog )

        PRINT "File ";i;"::Analog ";j;": ";PROPLIST.GETSELECTED( i, PL_Type_Analog, j ),

     ENDFOR

  ENDFOR

ENDIF

 

DIM defpoints AS STRING

DIM defanalogs AS STRING

 

defpoints  = PROPLIST.GetSelected( PL_GetDefaultList, PL_Type_Point )

defanalogs = PROPLIST.GetSelected( PL_GetDefaultList, PL_Type_Analog )