GxVariant: SetRefPath

SetRefPath

Reference a gxVariant by path.



 Public Function SetRefPath(
	  ByVal path As String ) As Boolean

Parameters

path
The path to the gxVariant item

Return Values

On error FALSE (0) is returned and the error code/string in the GX system is set appropriately.

Languages

[Visual Basic] Public Function SetRefPath(ByVal Path As String) As Boolean

[Delphi] function SetRefPath(const Path : WideString) : Boolean;

[C++] BOOL SetRefPath(LPCTSTR Path);

Remarks

The variant data type can constitute a tree structure: every item in the tree is also a variant, and in turn can have child items. The item in the tree can be referenced by the path string, which has the following format:

condition[=value][,condition[=value]][/condition[=value][,condition[=value]]]

  • 1. the / character separates the levels of items in the tree
  • 2. the , character separates the search conditions
  • 3. the = character means the equality condition
  • 4. the C character selects a child item
  • 5. the L character selects a list item
  • 6. the X character means the index of the item
  • 7. the D character means the id of the item
  • 8. the V character means the value of the item
  • For example, get MRZ_NAME field from passport reader document object:

    path = "C,D=" & PRV_FIELDLIST & "/L,D=" & PRV_FIELD & ",V=" & PR_DF_MRZ_NAME

    See Also

    Class GxVariant Overview GxVariant Properties GxVariant Methods SetRefArray Size