BBjTemplatedString::getTerminatedFieldOffset

Description

In BBj 14.0 and higher, this method returns the zero-based offset of a BBjTemplatedString field since the beginning of the most recent linefeed-terminated field.

Syntax

Return Value

Method

int

getTerminatedFieldOffset(string fieldname)

Parameters

Variable

Description

fieldname

The name of the field.

Return Value

Returns zero-based offset of this field since the most recent variable length field.

Remarks

This value is typically used with the value of BBjTemplatedString::getTerminatedFieldNumber to specify a key in an MKEYED key definition.

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.