DdfGetFieldComments

Show this topic in Library frames

Applies to:

VAccess

Description

Reads field comments into the VAccess memory image from the COMMENT.DDF file.

Syntax

object.DdfGetFieldComments

The DdfGetFieldComments method syntax has these parts:


Part	Description
object	Required. The name of a valid VAccess control.

Return Value

DdfGetFieldComments returns a two-byte integer that holds the status of the VAccess control. If this is zero, the operation completed successfully.

Remarks

DdfGetFieldComments forces a refresh of the field comment information in the VAccess memory image. This will very rarely be needed, as any memory image update from the DDF will automatically refresh this information as well. It would only be needed when RefreshLocations has been set to false and the DDF information has been persisted; comment information is not persisted with other DDF information.

Unlike many of the other dictionary methods and properties, DdfGetFieldComments does not check RefreshLocations. Since its only purpose is to update information from the DDF, it assumes that it should read directly from the DDF.

Example

'getting fields 
Dim fields as Variant 
VAEngine.RefreshLocations = True 
VAEngine.DdfGetFieldComments = True 
VAEngine.TableName = tableName 
	 
fields = VAEngine.FieldList 
VAEngine.RefreshLocations = False 
If not IsEmpty(fields) 
	For i = 0 to ubound(fields, 2) 
'put field names and comments in a list box 
		List.AddItem (fields(1,i) + fields(6, i)) 
	Next i 
End If