<table> attributes
List of attributes for <table> command.
alias
alias |
|
---|---|
Syntax |
[alias = string] |
May occur in |
<table> |
Description |
An optional alias to be used to reference the table in the request, and to be used instead of the tablename in the response. In the request both the tablename and alias attributes must be used whenever referencing this table since only the combination of the attributes tablename and alias is unique in the request. |
Remarks |
If a table is read multiple times, all but one must have an alias defined (to distinguish references to them in the request). |
allfields
allfields |
|
---|---|
Syntax |
[allfields = Boolean : false] |
May occur in |
<table> |
Description |
An indicator of whether all fields should be read and returned in the response. |
Remarks |
none |
flags
flags |
|
---|---|
Syntax |
[flags = mmFlags] |
May occur in |
<table> |
Description |
Flags influencing the read operation. |
Remarks |
See Cursor Flags. |
flags2
flags2 |
|
---|---|
Syntax |
[flags2 = mmFlags] |
May occur in |
<table> |
Description |
Flags influencing the read operation. |
Remarks |
See Cursor Flags. |
index
index |
|
---|---|
Syntax |
[index = unsignedByte] |
May occur in |
<table> |
Description |
The index to be used when reading this table. |
Remarks |
Available indexes can be queried using the <metainfo> command (or looked up in the CRMwin service module). |
keys
keys |
|
---|---|
Syntax |
[keys = string] |
May occur in |
<table> |
Description |
An optional key value used in conjunction with the index, setlen and keysend attributes. |
Remarks |
Deprecated, use a condition instead. |
keysend
keysend |
|
---|---|
Syntax |
[keysend = string] |
May occur in |
<table> |
Description |
An optional key value for range keys, used in conjunction with the index, setlen and keys attributes. |
Remarks |
Deprecated, use a condition instead. |
linkId
linkId |
|
---|---|
Syntax |
[linkId = short] |
May occur in |
<table> |
Description |
The id that specifies the relation between two tables. |
Remarks |
See samples using linkId in this document. |
maxrecords
maxrecords |
|
---|---|
Syntax |
[maxrecords = ] [maxrecords = unsignedInt] |
May occur in |
<table> |
Description |
The maximum number of records to be read for this table. |
Remarks |
none |
readtype
readtype |
|
---|---|
Syntax |
[readtype = string] |
May occur in |
<table> |
Description |
A mode how to read the table. |
Remarks |
Internal use only. |
relindex
relindex |
|
---|---|
Syntax |
[relindex = short] |
May occur in |
<table> |
Description |
Deprecated, only retained for backwards compatibility. Use the linkId attribute instead. |
Remarks |
none |
setlen
type |
|
---|---|
Syntax |
[setlen = unsignedByte] |
May occur in |
<table> |
Description |
An optional length for keys, used in conjunction with the index, keys and keysend attributes. |
Remarks |
Deprecated, use a condition instead. |