GetFileItem Method (TREEVIEW)
10.3A, PLBCMP GUI Only
The GetFileItem method returns the number of file names selected by an end-user and dragged to a TREEVIEW object. The method uses the following format:
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A TREEVIEW object that has been previously created.
return
Optional. A Numeric Variable that returns the number of file names selected by the end-user file drag/drop operation.
index
Required. A Numeric Variable or decimal number that is a zero-based index into an array of file selection of files that have been dragged and dropped onto the TREEVIEW.
flags
Optional. A Numeric Variable or decimal number whose value identifies the type of data being retrieved for a given file selection.
Flags Affected: OVER, ZERO
Note the following:
The {index} value specifies which file name is to be returned from the last TREEVIEW file drag/drop operation. If the {index} value is larger than the number of file names available, the {return} string is NULL.
If {return} is too small to contain a file name string, the EOS Condition Flag is set.
The OVER and ZERO Condition Flags are always cleared.
The {flags} is a bit mask value that identifies the type of data being returned for a file. If more than one data type is specified by the {flags} bit mask value, the '|' character is used as a delimiter between the returned data components. The {flags} bit mask values are described as follows:
|
Value |
Description |
|
0x01 |
This bit specifies that the path and file name is to be returned. The path identifies the directory from which the file was dragged. |
|
0x02 |
This bit specifies that the file type is to be returned. The file type is an extension string. |
|
0x04 |
This bit value normally specifies the filesize of the file selection. For Windows PL/B runtimes this value is always returned as zero for the filesize. |
See Also: Method Syntax, TREEVIEW Methods
|
|