File_Field_Current_Pointer_Value - DataDictionary
Returns a pointer to data in the extended foreign table column object
Type: Property
Access: Read/Write
Data Type: Address
Parameters: None
Parameters
| Parameter | Type | Description |
|---|---|---|
| iFile | Integer | Number of table in current filelist |
| iField | Integer | Number of column iField in table |
| iLen | Integer | Length of data in column iField |
Syntax
Property Address File_Field_Current_Pointer_Value
| Access Type | Syntax |
|---|---|
| Read Access: | Get File_Field_Current_Pointer_Value to AddressVariable |
| Write Access: | Set File_Field_Current_Pointer_Value to AddressVariable/Value |
Description
File_Field_Current_Pointer_Value returns a pointer to the data in the extended foreign column object. You can use this to make a copy of this data. While you could use this to change the data, you are not encouraged to do so. If you need to change the data in the extended column object, use File_Field_Pointer_Entry.
This is called to move data from an entry source to the DD extended buffer. This is identical to the File_Field_Current_Value except that a pointer to the data is passed. You must make sure that this pointer addresses valid memory and that the length of the data is correct. If the length passed is less than the column length, the rest of the column will be zero filled. If the length passed is greater than the length of the column, the length will be truncated.
It is expected that this message would only be used in batch processing.
File and File_Field Interfaces
Many of the DataDictionary methods contain a two variants of the same message: Field_Message and File_Field_Message. For a complete description of these messages please refer to The Field and File_Field DD Interfaces.
The Field_ version of a message must use the keyword FIELD to identify the Table.Column name. The File_Field_ version must use the keyword FILE_FIELD to identify the Table.Column name. These should never be mixed!
// When using Field_ message use the FIELD keyword
Get Field_Current_Pointer_Value Field Customer.Name to sName
// When using the File_Field_ message use the FILE_FIELD keyword
Get File_Field_Current_Pointer_Value of oCustomer_DD File_Field Customer.Name to sName
See Also