RVC::DBTABLE Class Reference
Manages RVC::OBJTYPE_Table objects. More...
#include <rvc/dbtable.h>
Detailed Description
Manages RVC::OBJTYPE_Table objects.
RVC Object Types that this class supports: RVC::OBJTYPE_Table.
Default RVC Object Type for this class: RVC::OBJTYPE_Table.
Valid parents for this class:
- RVC::OBJTYPE_Database
- RVC::OBJTYPE_Database_Raster
- RVC::OBJTYPE_Database_VectorPoint
- RVC::OBJTYPE_Database_VectorLine
- RVC::OBJTYPE_Database_VectorPolygon
- RVC::OBJTYPE_Database_CAD
- RVC::OBJTYPE_Database_TIN
- RVC::OBJTYPE_Database_Shape
Member Typedef Documentation
| typedef std::vector<FIELDINFO> RVC::DBTABLE::FIELDINFOARRAY |
| typedef ENUMSET<USAGE, USAGE_LAST> RVC::DBTABLE::USAGESET |
Member Enumeration Documentation
Database table attachment type.
- Enumerator:
Table capability flags, passed to RVCDBTABLE::HasCapability().
- Enumerator:
Type of external table.
- Enumerator:
Flags for element referenced tables (TIN is the only one so far).
Result values for CompareStructures() method.
| enum RVC::DBTABLE::USAGE |
Table usage, defines specialized tables.
- Enumerator:
Constructor & Destructor Documentation
| RVC::DBTABLE::DBTABLE | ( | ) |
Default constructor.
| RVC::DBTABLE::DBTABLE | ( | const RVC::DBTABLE & | rhs | ) |
Copy constructor.
- Parameters:
-
rhs Copy Constructor
| virtual RVC::DBTABLE::~DBTABLE | ( | ) | [virtual] |
Destructor.
Member Function Documentation
Add a record to the table.
- Parameters:
-
Record Record to write Bookmark Bookmark of new record RETURNED
Add a record to the table.
- Returns:
- Record number for the new record Note: You should not depend on this returning the record number. If the table is a link to any external format, it may be returning a bookmark number instead. Eventually this method will be modified to only return ERRVALUE. This version would be deprecated, but it's the one you would call if you don't care what the new record number is.
Create an index on a field in the table.
- Parameters:
-
flags Type of key to make
| ERRVALUE RVC::DBTABLE::ChangeAttachmentType | ( | ATTACHMENT | Attachment, | |
| ELEMTYPE | ElemType = ELEMTYPE_Empty | |||
| ) |
Set table attachment type Note: This method resolves existing attached/related records and tries to keep everything correct.
| ERRVALUE RVC::DBTABLE::Combine | ( | const RVC::DBTABLE & | rhs, | |
| RVC::DBASE::JOINFLAGS | flags, | |||
| RVC::DBASE & | dest, | |||
| const RVC::DESCRIPTOR & | DestDescriptor | |||
| ) |
Combine rhs table with this table.
- Parameters:
-
dest Database in which to store table DestDescriptor Descriptor of new table
| DEPRECATED ERRVALUE RVC::DBTABLE::Combine | ( | const RVC::DBTABLE & | rhs, | |
| RVC::DBASE::JOINFLAGS | flags, | |||
| RVC::DBASE & | dest, | |||
| const MISTRING & | name, | |||
| const MISTRING & | desc | |||
| ) |
Combine rhs table with this table.
- Parameters:
-
dest Database in which to store table name Output table name desc Output table description
| STRUCTCOMPARE RVC::DBTABLE::CompareStructures | ( | const RVC::DBTABLE & | rhs | ) | const |
Compare two table structures.
- Returns:
- STRUCTCOMPARE enum value describing if and how the table structures match
| ATTACHMENT RVC::DBTABLE::ComputeMinimumAttachmentType | ( | ELEMTYPE | ElemType = ELEMTYPE_Empty |
) | const |
Determine the minimum ATTACHMENT type based on current attachmets.
Looks at current element to record attachments to determine the minimum setting for attachment.
If the table is RelatedOnly the returned type will be one of the attached (non-related) attachment types. Call ChangeAttachmentType to actually resolve the attachments. If the table is already OneToOne or Identity it will return that. It will never return suggest Identity unless the table is already Identity.
| ERRVALUE RVC::DBTABLE::CopyRecordAttachmentsTo | ( | RVC::DBTABLE & | DestTable, | |
| const SIMPLE_ARRAY< INT32 > & | SrcToDestTrans | |||
| ) | const |
Copy the direct record attachments from one table to another.
| ERRVALUE RVC::DBTABLE::CopyTo | ( | RVC::DBASE & | DestDatabase, | |
| RVC::DESCRIPTOR * | pDestDescriptor = 0, |
|||
| INT32 * | pNewTableNumber = 0, |
|||
| SIMPLE_ARRAY< INT32 > * | pRecordTrans = 0, |
|||
| DELEGATE_BOOL_UINT32 | Filter = 0, |
|||
| const RVC::CREDENTIALS * | pCredentials = 0, |
|||
| RVC::DBASE::COPYFLAG | flags = RVC::DBASE::COPYFLAG_None | |||
| ) | const |
Copy a table to another database.
- Parameters:
-
DestDatabase The database to copy to pDestDescriptor The new table's descriptor. If not specified, the new table will get the same descriptor as the source table. pRecordTrans Optional SIMPLE_ARRAY in which will be returned the translation from source record numbers to destination record numbers. This is only an issue if the source table has deleted records, or if the Filter is used to only copy a portion of the table. pNewTableNumber Pointer to INT32 into which to return the new table number. Filter Delegate to call to determine if a record should be copied. Example: DELEGATE_BOOL_UINT32(&bits, &BITSET::GetBit) Credentials The credentials to use when creating the table flags Supported copy flags: RVC::DBASE::COPYFLAG_RemoveStdAttribTables -- will silently refuse to copy the table if it's a standard attribute table RVC::DBASE::COPYFLAG_TableLinks -- If the table is a link to an external table, it will just make a new link in the destination database RVC::DBASE::COPYFLAG_MinimizeTableSize RVC::DBASE::COPYFLAG_FreezeComputedFields -- Any computed fields will be computed and frozen (no longer computed).
- Parameters:
-
pDestDescriptor New table's descriptor (will use source table's if not specified)
Delete a record from the table using the cursor and a bookmark.
Delete a record from the table using the record number.
| ERRVALUE RVC::DBTABLE::Drop | ( | bool | CleanDBList | ) |
Drop a table (delete).
- Parameters:
-
CleanDBList Remove the entries in the DBlist that refer to this table
Find the field corresponding to the name.
- Returns:
- Field number of >= 0, R_FieldNotFound if field does not exist, < 0 Error code
| DEPRECATED INT32 RVC::DBTABLE::FindField | ( | const RVC::OBJECTNAME & | name | ) | const |
Find the field corresponding to the name.
- Returns:
- Field number of >= 0, R_FieldNotFound if field does not exist, < 0 Error code
- Deprecated:
- Use the MISTRING version or FindFieldByShortName(), because field names can be bigger than 16 characters now
| INT32 RVC::DBTABLE::FindFieldByShortName | ( | const RVC::OBJECTNAME & | name | ) | const |
Find the field cooresponding to the name.
- Returns:
- Field number of >= 0, R_FieldNotFound if field does not exist, < 0 Error code
| INT32 RVC::DBTABLE::FindFieldByUsage | ( | RVC::DBTABLE::FIELDINFO::USAGE | Usage | ) | const |
Find a field with a specific usage.
Returns -1 if the table does not have a field with the specified usage. If the table has mutliple fields of the specified usage, it returns the first one.
| INT32 RVC::DBTABLE::FindRecords | ( | INT32 | FieldNum, | |
| const RECORD & | record, | |||
| SIMPLE_ARRAY< INT32 > & | FoundRecList, | |||
| INT32 | RecordFieldNum = -1 | |||
| ) | const |
Find the records that match the record data for a given field.
- Returns:
- Number of records found or <0 if error
- Parameters:
-
record Record containing stuff to compare to RecordFieldNum Record field number to use, default is 'FieldNum'
| INT32 RVC::DBTABLE::FindRecords | ( | INT32 | FieldNum, | |
| const MISTRING & | string, | |||
| SIMPLE_ARRAY< INT32 > & | FoundRecList | |||
| ) | const |
Find the records that match the record data for a given field.
- Returns:
- Number of records found or <0 if error
- Parameters:
-
string Buffer containing string to compare to
| INT32 RVC::DBTABLE::FindRecords | ( | INT32 | FieldNum, | |
| const MIUNICODE * | string, | |||
| SIMPLE_ARRAY< INT32 > & | FoundRecList | |||
| ) | const |
Find the records that match the record data for a given field.
- Returns:
- Number of records found or <0 if error
- Parameters:
-
string Buffer containing string to compare to
| INT32 RVC::DBTABLE::FindRecords | ( | INT32 | FieldNum, | |
| const char * | string, | |||
| SIMPLE_ARRAY< INT32 > & | FoundRecList, | |||
| CHAR_ENCODING | Encoding = CHAR_ENCODING_UTF8 | |||
| ) | const |
Find the records that match the record data for a given field.
- Returns:
- Number of records found or <0 if error
- Parameters:
-
string Buffer containing string to compare to
| INT32 RVC::DBTABLE::FindRecords | ( | INT32 | FieldNum, | |
| double | value, | |||
| SIMPLE_ARRAY< INT32 > & | FoundRecList | |||
| ) | const |
Find the records that match the record data for a given field.
- Returns:
- Number of records found or <0 if error
- Parameters:
-
value Buffer containing value to compare to
| INT32 RVC::DBTABLE::GetAttachedRecords | ( | INT32 | ElementNum, | |
| ELEMTYPE | ElemType, | |||
| SIMPLE_ARRAY< INT32 > & | RecordList, | |||
| FINDFLAG | FindFlags = FINDFLAG_AllAttached, |
|||
| DBTABLE * | SourceTable = 0 | |||
| ) | const |
Get the records attached to the element for this table.
- Returns:
- Number of records attached or <0 if error
- Parameters:
-
SourceTable Source table if ElemType == ELEMTYPE_Record
| static TEXTID RVC::DBTABLE::GetAttachmentTextID | ( | ATTACHMENT | attachment | ) | [static] |
Get TEXTID for attachment.
- Parameters:
-
attachment Attachment type
| ATTACHMENT RVC::DBTABLE::GetAttachmentType | ( | ) | const |
Get table attachment type.
- Returns:
- Table attachment type
Get the computed field query for a field.
| CHAR_ENCODING RVC::DBTABLE::GetEncoding | ( | ) | const |
Get table encoding.
- Returns:
- Table encoding
| ERRVALUE RVC::DBTABLE::GetFieldDescriptor | ( | INT32 | FieldNum, | |
| RVC::DESCRIPTOR & | Descriptor | |||
| ) | const |
Get the RVC::DESCRIPTOR for a single field.
| ERRVALUE RVC::DBTABLE::GetFieldIndex | ( | INT32 | FieldNum, | |
| SIMPLE_ARRAY< INT32 > & | Index, | |||
| BITSET & | DuplicateBits | |||
| ) |
Get the index for a field, will build one if needed.
- Parameters:
-
Index List of record numbers in sorted order DuplicateBits Bit set to true if value in the record for that field is equal to the previous record
| ERRVALUE RVC::DBTABLE::GetFieldInfo | ( | FIELDINFOARRAY & | FieldArray | ) | const |
Get the FIELDINFO's for the table.
Get the FIELDINFO for a single field.
| ERRVALUE RVC::DBTABLE::GetLinkFields | ( | INT32 | StartFieldNum, | |
| SIMPLE_ARRAY< INT32 > & | FieldNumArray | |||
| ) | const |
Get the list of fields linked to the starting field.
- Parameters:
-
StartFieldNum Field to start checking on FieldNumArray One item 'StartFieldNum' if no next_key links, > 1 items if next_key links exists
| LINKTYPE RVC::DBTABLE::GetLinkType | ( | ) | const |
Get the link type of this table.
| INT32 RVC::DBTABLE::GetNumDeletedRecords | ( | ) | const |
Get the number of deleted records in the table.
| INT32 RVC::DBTABLE::GetNumFields | ( | ) | const |
Get the number of field in the table.
- Returns:
- Number of fields
| INT32 RVC::DBTABLE::GetNumRecords | ( | ) | const |
Get the number of records in the table More accurately, this method returns the maximum record number + 1.
If the table has any deleted records, they are not subtracted from the count.
- Returns:
- Number of records
| REFELEM RVC::DBTABLE::GetReferenceElement | ( | ) | const |
Get reference element (This table belongs to what element?).
- Returns:
- Reference flags
| INT32 RVC::DBTABLE::GetRelatedRecords | ( | const RECORD & | record, | |
| SIMPLE_ARRAY< INT32 > & | RecordList, | |||
| FINDFLAG | FindFlags = FINDFLAG_AllAttached | |||
| ) | const |
Get the records from this table attached to the given record.
- Returns:
- Number of records attached or <0 if error
- Parameters:
-
record Record to get attachments for RecordList List of records that are related RETURNED FindFlags find flags
| INT32 RVC::DBTABLE::GetRelatedRecords | ( | INT32 | RecordNum, | |
| INT32 | BaseTableNum, | |||
| SIMPLE_ARRAY< INT32 > & | RecordList, | |||
| FINDFLAG | FindFlags = FINDFLAG_AllAttached | |||
| ) | const |
Get the records from this table attached to the record in the basetable.
- Returns:
- Number of records attached or <0 if error
- Parameters:
-
RecordNum Record in the base table to get attachments for BaseTableNum Basetable that contains the record stated above RecordList List of records that are related RETURNED FindFlags find flags
| ERRVALUE RVC::DBTABLE::GetTableMetadata | ( | SIMPLE_ARRAY< UINT8 > & | buffer | ) | const |
Get the metadata for the table.
Note that this method differs from RVC::OBJECT::GetMetadata in that this one will make sure that the returned metadata includes descriptors for all the fields, even if the actual object doesn't have metadata for them.
| INT32 RVC::DBTABLE::GetTableNumber | ( | ) | const |
Get table number.
- Returns:
- Table number
| USAGE RVC::DBTABLE::GetUsage | ( | ) | const |
Get table usage.
- Returns:
- Table usage
| VIEWMODE RVC::DBTABLE::GetViewMode | ( | ) | const |
Get the default view mode.
| LRECT2D RVC::DBTABLE::GetWindowRect | ( | ) | const |
Get view position of table.
- Returns:
- Table view position
| bool RVC::DBTABLE::HasCapability | ( | CAPABILITY | capability | ) | const |
Get table capability.
- Returns:
- Table capability
| static bool RVC::DBTABLE::HasDBTypeCapability | ( | LINKTYPE | LinkType, | |
| CAPABILITY | Capability | |||
| ) | [static] |
Determine if a database type supports a given capability.
| bool RVC::DBTABLE::IsHidden | ( | ) | const |
Is the table hidden?
- Returns:
- 'True' if the table is hidden
| bool RVC::DBTABLE::IsInternal | ( | ) | const |
Is table an internal (no storage representation) table.
- Returns:
- 'True' if the table is internal
| bool RVC::DBTABLE::IsMissing | ( | ) | const |
Is table missing.
Occurs with linked tables
- Returns:
- 'True' if the table is missing
| bool RVC::DBTABLE::IsPrompt | ( | ) | const |
Is table a prompt table.
Used for adding elements
- Returns:
- 'True' if the table is a prompt table
| bool RVC::DBTABLE::IsUserDefined | ( | ) | const |
Is table a UserDefined table.
(Currently USAGE_UserDefined||USAGE_Sketch||USAGE_Shape)
- Returns:
- 'True' if the table is a user defined table
| bool RVC::DBTABLE::IsValid | ( | ) | const |
Is table valid.
Occurs with deleted tables
- Returns:
- 'True' if the table is valid
| bool RVC::DBTABLE::IsWritable | ( | ) | const |
Can the table be written to?
- Returns:
- 'True' if the table is writable
Reimplemented from RVC::OBJECT.
| ERRVALUE RVC::DBTABLE::Link | ( | RVC::DBASE & | parent, | |
| const DESCRIPTOR & | Descriptor, | |||
| const LINKPARMS & | LinkParms, | |||
| const CREDENTIALS *pCredentials | RVC_DEFAULT_CREDENTIALS | |||
| ) |
Link to an external table, field info returned in the LINKPARMS.
- Parameters:
-
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
| ERRVALUE RVC::DBTABLE::Make | ( | RVC::DBASE & | parent, | |
| const DESCRIPTOR & | Descriptor, | |||
| MAKEPARMS & | MakeParms, | |||
| const CREDENTIALS *pCredentials | RVC_DEFAULT_CREDENTIALS | |||
| ) |
Make a table.
- Parameters:
-
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
| ERRVALUE RVC::DBTABLE::MakeDistinctTableFromField | ( | RVC::DBASE & | parent, | |
| const RVC::DBTABLE & | SourceTable, | |||
| INT32 | Field, | |||
| const DESCRIPTOR & | Descriptor, | |||
| const CREDENTIALS *pCredentials | RVC_DEFAULT_CREDENTIALS | |||
| ) |
Create a new table with one field listing all distinct values of a specific field.
- Parameters:
-
Descriptor Field number from source table RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
| ERRVALUE RVC::DBTABLE::Open | ( | OPENMODE | OpenMode = OPENMODE_Read, |
|
| MDLGPARENT | dlgparent = 0, |
|||
| const CREDENTIALS * | pCredentials = 0 | |||
| ) |
Open an attached RVC::DBTABLE instance.
The instance must be attached for this to work.
- Parameters:
-
OpenMode Mode in which to open the rvc object dlgparent Parent dialog handle, 0 for default handle pCredentials User credentials passed in, NULL for default behavior
Reimplemented from RVC::OBJECT.
| ERRVALUE RVC::DBTABLE::Open | ( | const RVC::OBJITEM & | ObjItem, | |
| OPENMODE | OpenMode = OPENMODE_Read, |
|||
| MDLGPARENT | dlgparent = 0, |
|||
| const CREDENTIALS * | pCredentials = 0 | |||
| ) |
Open an RVC::DBTABLE instance using a RVC::OBJITEM instance.
This method will attach and open the file and database table object if possible
- Parameters:
-
ObjItem This contains the file and rvc object location information OpenMode Mode in which to open the rvc object dlgparent Parent dialog handle, 0 for default handle pCredentials User credentials passed in, NULL for default behavior
Reimplemented from RVC::OBJECT.
| ERRVALUE RVC::DBTABLE::Open | ( | const DBTABLE & | twin, | |
| OPENMODE | OpenMode = OPENMODE_Read, |
|||
| MDLGPARENT | dlgparent = 0, |
|||
| const CREDENTIALS * | pCredentials = 0 | |||
| ) |
Open a table using another instance of that table.
- Parameters:
-
OpenMode Mode in which to open the rvc object dlgparent Parent dialog handle, 0 for default handle pCredentials User credentials passed in, NULL for default behavior
Reimplemented from RVC::OBJECT.
| ERRVALUE RVC::DBTABLE::Open | ( | const RVC::DBASE & | parent, | |
| INT32 | TableNum, | |||
| OPENMODE | OpenMode = OPENMODE_Read, |
|||
| MDLGPARENT | dlgparent = 0, |
|||
| const CREDENTIALS * | pCredentials = 0 | |||
| ) |
Open an existing table using the table index.
- Parameters:
-
OpenMode Mode in which to open the rvc object dlgparent Parent dialog handle, 0 for default handle pCredentials User credentials passed in, NULL for default behavior
| ERRVALUE RVC::DBTABLE::Open | ( | const RVC::DBASE & | parent, | |
| const RVC::OBJECTNAME & | ShortName, | |||
| OPENMODE | OpenMode = OPENMODE_Read, |
|||
| MDLGPARENT | dlgparent = 0, |
|||
| const CREDENTIALS * | pCredentials = 0 | |||
| ) |
Open an existing table using the table name.
- Parameters:
-
OpenMode Mode in which to open the rvc object dlgparent Parent dialog handle, 0 for default handle pCredentials User credentials passed in, NULL for default behavior
| ERRVALUE RVC::DBTABLE::Open | ( | const RVC::DBASE & | parent, | |
| const MISTRING & | TableName, | |||
| OPENMODE | OpenMode = OPENMODE_Read, |
|||
| MDLGPARENT | dlgparent = 0, |
|||
| const CREDENTIALS * | pCredentials = 0 | |||
| ) |
Open an existing table using the table name.
- Parameters:
-
OpenMode Mode in which to open the rvc object dlgparent Parent dialog handle, 0 for default handle pCredentials User credentials passed in, NULL for default behavior
| RVC::DBTABLE& RVC::DBTABLE::operator= | ( | const RVC::DBTABLE & | rhs | ) |
Assignment.
Reimplemented from RVC::OBJECT.
Reimplemented in RVC::DBTABLE_PROPERTIES, and RVC::DBTABLE_STYLE.
| ERRVALUE RVC::DBTABLE::Read | ( | CURSOR & | cursor, | |
| const BOOKMARK & | bookmark, | |||
| RECORD & | Record | |||
| ) | const [inline] |
Read a record from the table using a cursor / bookmark pair into a pre-allocated buffer.
Read a record from the table using a cursor into a pre-allocated buffer.
Read a record from the table using a record number into a pre-allocated buffer.
Read a record from the table using a bookmark (relative to the default bookmark cursor) into a pre-allocated buffer.
| ERRVALUE RVC::DBTABLE::ReadConstraint | ( | std::vector< CONSTRAINT > & | ConstraintList | ) | const |
Read a record from the table using a record number into a pre-allocated buffer.
| INT32 RVC::DBTABLE::ReadInverseDBList | ( | INT32 | RecNum, | |
| SIMPLE_ARRAY< DBLISTELMT > & | List | |||
| ) |
| void RVC::DBTABLE::RecordBegin | ( | RECORDITERATOR & | Iterator, | |
| ITERATERECORD | IterateRecord = ITERATERECORD_SkipDeleted, |
|||
| INT32 | FieldNum = 0 | |||
| ) |
Get an iterator to the first viable record in the table.
| void RVC::DBTABLE::RecordBegin | ( | CONST_RECORDITERATOR & | Iterator, | |
| ITERATERECORD | IterateRecord = ITERATERECORD_SkipDeleted, |
|||
| INT32 | FieldNum = 0 | |||
| ) | const |
Get a constant iterator to the first viable record in the table.
| ERRVALUE RVC::DBTABLE::RemoveDuplicateRecords | ( | ) |
Remove duplicate records from the table.
| ERRVALUE RVC::DBTABLE::RemoveUnattachedRecords | ( | ) |
Remove unattached records from the table.
Set the number of records in the table. Does not work with ATTACHMENT_Identity tables.
| INT32 RVC::DBTABLE::SearchIndex | ( | INT32 | FieldNum, | |
| const RECORD & | Record, | |||
| INT32 | RecFieldNum, | |||
| INT32 & | offset, | |||
| INDEXSEARCH | flag | |||
| ) | const |
Search field index with a value in the RECORD for the match.
- Returns:
- Number of matches or error < 0
| INT32 RVC::DBTABLE::SearchIndex | ( | INT32 | FieldNum, | |
| const MISTRING & | value, | |||
| INT32 & | offset, | |||
| INDEXSEARCH | flag | |||
| ) | const |
Search field index with a string value for the match.
- Returns:
- Number of matches or error < 0
| INT32 RVC::DBTABLE::SearchIndex | ( | INT32 | FieldNum, | |
| double | value, | |||
| INT32 & | offset, | |||
| INDEXSEARCH | flag | |||
| ) | const |
Search field index with a double value for the match.
- Returns:
- Number of matches or error < 0
| INT32 RVC::DBTABLE::SearchIndex | ( | INT32 | FieldNum, | |
| const _CT & | item, | |||
| INT32 & | offset, | |||
| INDEXSEARCH | flag = INDEXSEARCH_ReturnIndexOffset, |
|||
| CHAR_ENCODING | Encoding = CHAR_ENCODING_ASCII | |||
| ) | const [inline] |
Search field index with a value that matches the field to search for the record match.
- Returns:
- Number of matches or error < 0
- Parameters:
-
item MUST MATCH 'FieldNum' field type and size Encoding Encoding to use (ignored except for non-unicode string fields)
| INT32 RVC::DBTABLE::SearchIndex | ( | INT32 | FieldNum, | |
| const _CT & | item, | |||
| const FIELDINFO & | finfo, | |||
| INT32 & | offset, | |||
| INDEXSEARCH | flag = INDEXSEARCH_ReturnIndexOffset, |
|||
| CHAR_ENCODING | Encoding = CHAR_ENCODING_ASCII | |||
| ) | const [inline] |
Search field index with a value for the record match.
- Returns:
- Number of matches or error < 0
- Parameters:
-
Encoding Encoding to use (ignored except for non-unicode string fields)
| ERRVALUE RVC::DBTABLE::SetAttachmentType | ( | ATTACHMENT | Attachment | ) |
Set table attachment type Note: This just blindly sets the attachment type without resolving anything.
Call ChangeAttachmentType if you need to resolve existing relationships and attachments
Set the computed field query for a field.
| void RVC::DBTABLE::SetEncoding | ( | CHAR_ENCODING | Encoding | ) |
Set table encoding.
| ERRVALUE RVC::DBTABLE::SetFieldDescriptor | ( | const RVC::DESCRIPTOR & | Descriptor | ) |
Set the RVC::DESCRIPTOR for a single field Note, there is no field number.
The ShortName of the descriptor should match the short name of an existing field
| ERRVALUE RVC::DBTABLE::SetFieldInfo | ( | FIELDINFOARRAY & | FieldArray, | |
| const SIMPLE_ARRAY< int > & | NewToOld | |||
| ) |
Modify all table FIELDINFO's.
| ERRVALUE RVC::DBTABLE::SetFieldInfo | ( | FIELDINFOARRAY & | FieldArray | ) |
Modify all table FIELDINFO's.
Modify specific table FIELDINFO.
| ERRVALUE RVC::DBTABLE::SetPromptOnAddElement | ( | bool | prompt = true |
) |
Set whether or not this table should "Prompt when adding elements".
| ERRVALUE RVC::DBTABLE::SetReadOnly | ( | bool | bReadOnly = true |
) |
Set the "read only" bit in the table header (will go away in favor of ACL).
| ERRVALUE RVC::DBTABLE::SetUsage | ( | DBTABLE::USAGE | usage | ) |
Set table usage.
| void RVC::DBTABLE::SetWindowRect | ( | const LRECT2D & | rect | ) |
Set view position of table.
| ERRVALUE RVC::DBTABLE::UpgradeLinkToOLEDB | ( | ) |
If a table is an ODBC link to Access or Excel, this method will convert it to an OLE-DB link.
WARNING! Doing so will render the link unusable in TNT 2005:71 and earlier.
| ERRVALUE RVC::DBTABLE::ValidateAccess | ( | INT32 | FieldNum, | |
| PERMISSIONS | Permission, | |||
| bool | bGenerateErrorMsg = true | |||
| ) | const |
Determine if the current user has permission to a given field in this table.
- Returns:
- 0 If user has access, error code < 0 if not
- Parameters:
-
bGenerateErrorMsg Pass false to not SetErrPosn on error
| ERRVALUE RVC::DBTABLE::ValidateAccess | ( | PERMISSIONS | Permission, | |
| bool | bGenerateErrorMsg = true | |||
| ) | const |
Determine if the current user has permission to access this table.
- Returns:
- 0 If user has access, error code < 0 if not
- Parameters:
-
bGenerateErrorMsg Pass false to not SetErrPosn on error
| ERRVALUE RVC::DBTABLE::ValidateTableName | ( | OBJECTNAME & | NewTableName, | |
| SIMPLE_ARRAY< OBJECTNAME > & | NewFieldNames | |||
| ) |
Make sure that a table and field names are valid and unique This version assumes the table already exists.
There is also a ValidateTableName method on DBASE for use when creating a new table
| ERRVALUE RVC::DBTABLE::Write | ( | CURSOR & | cursor, | |
| const BOOKMARK & | bookmark, | |||
| RECORD & | Record | |||
| ) | [inline] |
Write a record in the table using a cursor / bookmark pair from a buffer.
Write a record in the table using a cursor from a buffer.
Write a record to the table using a bookmark (relative to the default bookmark cursor).
Write a record in the table using a record number from a buffer.
| ERRVALUE RVC::DBTABLE::WriteConstraint | ( | const std::vector< CONSTRAINT > & | ConstraintList | ) |
The documentation for this class was generated from the following file:
- rvc/dbtable.h
