Top Method Summary
Options Name Purpose
CHARACTER BuildToken (handle) Builds the record identity token for the record in the given buffer
CHARACTER DecodeValue (character) Decodes a key value from its escaped token representation
CHARACTER EncodeValue (character) Escapes the token structure characters (percent, pipe and hash) in a key value
CHARACTER KeyWhereClause (character, handle) Builds the query string predicate (including the WHERE keyword) locating the record identified by the given record identity token
CHARACTER TableName (character) Returns the table segment of the given record identity token
CHARACTER UniqueKeyFields (handle) Returns the unique key fields of the given buffer used for the record identity token


Method Detail
Top

CHARACTER BuildToken (handle)

Purpose: Builds the record identity token for the record in the
given buffer
Notes: The token format is <Entity>#<key> where <Entity> is the
serialize-name of the buffer and <key> carries the
escaped values of the unique key fields of the buffer,
joined with the pipe character

Parameters:
phBuffer HANDLE
The buffer positioned on the record to build the token for
Returns CHARACTER
The record identity token
Top

CHARACTER DecodeValue (character)

Purpose: Decodes a key value from its escaped token representation
Notes: Counterpart of EncodeValue

Parameters:
pcValue CHARACTER
The escaped key value
Returns CHARACTER
The decoded key value
Top

CHARACTER EncodeValue (character)

Purpose: Escapes the token structure characters (percent, pipe and
hash) in a key value
Notes: The percent character is escaped first so the escape
sequences themselves round-trip

Parameters:
pcValue CHARACTER
The key value to escape
Returns CHARACTER
The escaped key value
Top

CHARACTER KeyWhereClause (character, handle)

Purpose: Builds the query string predicate (including the WHERE
keyword) locating the record identified by the given
record identity token
Notes: The key values of the token are converted into the data
types of the unique key fields of the given buffer, so
the predicate carries correctly typed literals. The
table segment of the token must match the serialize-name
of the buffer

Parameters:
pcToken CHARACTER
The record identity token to parse
phBuffer HANDLE
The (schema) buffer of the table the token identifies a record of
Returns CHARACTER
The query string predicate for the record
Top

CHARACTER TableName (character)

Purpose: Returns the table segment of the given record identity
token
Notes:

Parameters:
pcToken CHARACTER
The record identity token
Returns CHARACTER
The name of the table the token identifies a record of
Top

CHARACTER UniqueKeyFields (handle)

Purpose: Returns the unique key fields of the given buffer used
for the record identity token
Notes: Prefers the primary unique index and falls back to the
first unique index when the primary index is not unique

Parameters:
phBuffer HANDLE
The buffer to return the unique key fields of
Returns CHARACTER
The comma-delimited list of unique key fields


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:23:23