BBjTemplatedString::getFieldTerminator

Description

In BBj 14.00 and higher, this method returns the terminator of a BBjTemplatedString field.

Syntax

Return Value

Method

int

getFieldTerminator(string fieldname)

Parameters

Variable

Description

fieldname

The name of the field.

Return Value

Returns the field terminator, if defined. Returns 0 for fixed-length fields or variable length fields terminated by the end of the string.

Example

rem ' BBjTemplatedString
t$ = "state:c(2),name:c(25+=8),capital:c(25**=9),pop:n(6*),size:n(5*=)"
t! = bbjapi().makeTemplatedString(t$)
print t!.fattr()
n! = t!.getFieldNames()
for f = 0 to n!.size() - 1
  f$ = n!.get(f)
  print ""
  print f$,
  print ",getFieldType=",t!.getFieldType(f$),
  print ",getFieldLength=",t!.getFieldLength(f$),
  print ",getFieldRepeat=",t!.getFieldRepeat(f$),
  print ",isFieldTerminated=",t!.isFieldTerminated(f$),
  print ",getFieldTerminator=",t!.getFieldTerminator(f$),
  print ",isFieldTerminatorEscaped=",t!.isFieldTerminatorEscaped(f$),
  print ",isFieldEOSTerminated=",t!.isFieldEOSTerminated(f$),
  print ",isFieldPadded=",t!.isFieldPadded(f$),
  print ""
next f

See Also

String Templates

BBjAPI

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.