7#ifndef __TRIPAPI_PROTOTYPES__
8#define __TRIPAPI_PROTOTYPES__
14#if __cplusplus >= 201300
15#define TDB_DEPRECATED(msg) [[deprecated(msg)]]
20#define TDB_DEPRECATED(msg) __declspec(deprecated(msg))
21#elif defined(__GNUC__) || defined(__clang__)
22#define TDB_DEPRECATED(msg) __attribute__((deprecated))
24#define TDB_DEPRECATED(msg)
29#include "tripapi_defs.h"
30#include "tripapi_types.h"
32#if defined(__cplusplus)
115 size_t bufsize,
size_t* readcount);
342 int TdbCheckUser(
const char* user,
const char* password,
char* FM,
char* UM,
char* SM);
517 int TdbMessage(
int messageNumber,
char* message,
int* length);
808 int TdbStartTrip(
char* username,
char* password,
int language,
int mode);
871 char* valueBuffer,
size_t bufferSize,
872 const char* defaultValue);
881 int TdbSetConf(
const char* symbolName,
const char* symbolValue);
1266 char* string_buffer,
size_t string_buffer_size);
1557 int64_t* recordCount);
1608 int* length,
int* recordCount);
1666 int* length, int64_t* recordCount,
1667 int64_t* updateCount);
1961 int* colSize,
int* rowCount,
int* flags);
2505 int TdbChangeFm(
const char* old_fm,
const char* new_fm,
const char* base);
2578 int TdbChangeUm(
const char* old_um,
const char* new_um,
const char* user_group);
3275 int TdbBaseInfo(
const char* base,
int mode,
char* cvalue,
int* ivalue);
3919 char* string_value_buffer,
int string_buffer_size);
3998 const char* string_value);
4065 const char* fieldName,
int ordinal);
4331 int* numeric_value,
char* string_value_buffer,
4332 int string_buffer_size);
4418 int numeric_value,
const char* string_value);
4453 TdbHandle base_design_handle,
4454 const char* name,
int ordinal);
4567 char* string_value_buffer,
int string_buffer_size);
4596 int numeric_value,
const char* string_value);
4680 TdbHandle* field_handle,
4681 const char* field_name,
5114 const char* cluster_name,
5206 TdbHandle* targetHandle);
5314 char* name,
int namesize);
5338 char* name,
int namesize);
5367 int* numeric_value,
char* string_value_buffer,
5368 int string_buffer_size);
5396 int numeric_value,
const char* string_value);
5533 char* new_form,
int* error);
5885 int* field,
int* paragraph,
int* item);
6090 int* type,
int* flags);
6416 int* part,
int* field,
int* paragraph,
int* item);
6717 char* block,
int* blockLen);
6833 int TdbGetItem(TdbHandle cursor,
char* data_item,
int* item_length);
6881 int maximum_length);
7014 int* paragraph,
int* item,
int* word_position,
7177 int buffer_length,
int part_number,
7178 int* filled_length);
7240 TDB_DEPRECATED(
"Deprecated by TdbGetRecord")
7371 int* RID,
char* base);
7490 int* rid,
char* base);
7573 int TdbHitParts(TdbHandle recordControl,
int* parthits,
int* partcount,
8151 int buffer_len,
int* err_partnr,
int* err_fieldnr,
8441 int TdbSetBase(TdbHandle recordControl,
char* base,
int access_mode);
8505 int paragraph,
int item);
8561 TdbHandle* base_id);
8969 int* hit_cnt,
int** hit_vec,
int* para_cnt);
9323 char* stringValue,
size_t strvalsz,
int* intValue);
10023 int exclusionSet, const
char* condition);
10071 const
char* database);
10130 boolean allEdges,
int edgeSet,
int sourceSet,
10131 int targetSet, const
char* condition);
10191 int originSet,
int edgeSet,
10192 int destinationSet,
boolean reverse,
10193 const
char* condition);
10399 char** database,
int* recordId);
10460 const
char* edgeName, TdbHandle sourceRecord,
10461 TdbHandle targetRecord,
double weight);
10524 const
char* label, TdbHandle referenceRecord);
10527#ifndef DOXYGEN_SHOULD_SKIP_THIS
10544 int TdbGraphQuery(
int* resultSet,
int* setType,
int* recordCount,
10545 const char* query);
10578 boolean validate,
const char* xmldata,
int length);
10616 boolean validate,
const char* xmlfile);
10724 int startRis,
int endRis,
boolean highlight,
10725 void** buffer,
int* length);
10837 const char* targetFieldName,
10838 const char* propertyNameField,
10839 const char* propertyValueField,
10840 const char* sourceFieldName,
10841 const char* fileName);
10867 const char* targetTextFieldName,
10868 const char* propertyNameField,
10869 const char* propertyValueField,
10870 const char* targetStringFieldName,
10871 const char* fileName);
10899 const char* targetFieldName,
10900 const char* propertyNameField,
10901 const char* propertyValueField,
10902 const char* targetStringFieldName,
10903 unsigned char* filedata,
10904 size_t fileDataSize,
10905 const char* fileName);
11001 TDB_DEPRECATED(
"Deprecated by TdbStartTrip")
11382 TDB_DEPRECATED("Deprecated without replacement")
11812 char** cclOrder,
int* length);
11961 Char* FM, Char* UM, Char* SM);
12102#if defined(__cplusplus)
int TdbCloseBaseField(TdbHandle *handle)
Closes a field specification handle.
int TdbBaseStatus(const char *base, char *revisionDate, char *indexDate, int *recordCount)
Retrieve certain information concerning the state of a given database.
int TdbPutFieldProperty(TdbHandle field_design_handle, int property_id, int numeric_value, const char *string_value)
Assign a field design property.
int TdbCopyBaseDesign(const char *from_base, const char *to_base, TdbHandle *design)
Create a copy of a database definition.
int TdbCheckForeignKey(Char *keyfield, Char *parentdb, Char *parentfld)
Validates that the defined foreign key, when set, will succeed.
int TdbGetDbAccess(char *user, base_access_rec *baseAccess)
Load the base access record for a TRIP user.
int TdbGetBaseField(TdbHandle *fieldHandle, TdbHandle baseHandle, const char *fieldName, int ordinal)
Load a field specification from a database design.
int TdbDeleteForeignKey(Char *keyfield)
Remove a foreign key from the current database.
int TdbDeleteThesDef(void)
Delete a thesaurus definition.
int TdbSetForeignKey(Char *keyfield, Char *parentdb, Char *parentfld, int upd, int del)
Establishes a new foreign key relationship.
int TdbCloseClusterDesign(TdbHandle *handle)
Close a cluster design handle.
int TdbFieldGroupGetField(TdbHandle field_group_handle, TdbHandle *field_handle, const char *field_name, int ordinal)
Retrieve a field from a field group.
int TdbFieldGroupDelField(TdbHandle handle, const char *field_name)
Remove a field from a field group.
int TdbCopyClusterDesign(TdbHandle sourceHandle, const char *newName, TdbHandle *targetHandle)
Copy a database cluster.
int TdbPutBaseDesign(TdbHandle handle)
Store a database definition.
int TdbPutFieldGroupProperty(TdbHandle handle, int property_id, int numeric_value, const char *string_value)
Assign field group properties.
int TdbPutClusterProperty(TdbHandle handle, int property_id, int numeric_value, const char *string_value)
Assign a property of a database cluster.
int TdbBaseInfo(const char *base, int mode, char *cvalue, int *ivalue)
Retrieve selected information about a database.
int TdbClusterGetMember(TdbHandle handle, int position, char *name, int namesize)
Retrieive the name of a cluster member.
int TdbCloseBaseDesign(TdbHandle *handle)
Close a database design handle.
int TdbPutBaseProperty(TdbHandle handle, int property_id, int numeric_value, const char *string_value)
Assign a database design property.
int TdbPutThesDesign(TdbHandle handle)
Store a thesaurus definition.
int TdbCopyThesDesign(const char *from_thes, const char *to_thes, TdbHandle *design)
Create a copy of a thesaurus definition.
int TdbPutDbAccess(base_access_rec *baseAccess)
Store the base access record for a TRIP user.
int TdbGetDefaultValue(Char *fieldName, Char *fieldValue, int *fieldLength)
Retrieve the default value for the specified field.
int TdbPutClusterDesign(TdbHandle handle)
Store a database cluster specification.
int TdbDeleteDefaultValue(Char *fieldName)
Remove any existing default value for a field.
int TdbClusterEnumMembers(TdbHandle handle, int *position, char *name, int namesize)
Iterator function to retrieve the names of all cluster members.
int TdbFieldGroupAddField(TdbHandle handle, const char *field_name)
Add a field to a field group.
int TdbFreeIntegrityRules(base_integrity_spec *rules)
Release an integrity rules structure.
int TdbClusterDelMembers(TdbHandle handle)
Delete all members from a cluster.
int TdbDeleteBaseFieldGroup(TdbHandle *handle)
Delete a database field group.
int TdbGetBaseFieldByNumber(TdbHandle *fieldHandle, TdbHandle baseHandle, int fieldNumber)
Load a field specification from a database design.
int TdbPutBaseFieldGroup(TdbHandle handle)
Store a field group definition.
int TdbGetThesDesign(TdbHandle *handle, const char *name, int accessMode)
Load a thesaurus design.
int TdbClusterDelMember(TdbHandle handle, int position, const char *name)
Delete a member from a cluster.
int TdbCheckFieldName(const char *field_name)
Check for the existence of a field.
int TdbClusterAddMember(TdbHandle handle, const char *name)
Add a member to a cluster.
int TdbPutTextSeparators(text_sepa_rec *separatorSpec)
Store a text separator specification.
int TdbGetBaseProperty(TdbHandle handle, int property_id, int *numeric_value, char *string_value_buffer, int string_buffer_size)
Retreieve database design properties.
int TdbPutDefaultValue(Char *fieldName, Char *fieldValue)
Set the default value for a field.
int TdbCheckBase(const char *base, int accessMode)
Check access rights to a database.
int TdbGetBaseDesign(TdbHandle *handle, const char *base, int accessMode)
Load a database design.
int TdbCloseBaseFieldGroup(TdbHandle *handle)
Close a database field group.
int TdbGetClusterProperty(TdbHandle handle, int property_id, int *numeric_value, char *string_value_buffer, int string_buffer_size)
Retrieve a property of a database cluster.
int TdbDeleteIntegrityRules()
Delete all integrity rules for the current database.
int TdbGetIntegrityRules(base_integrity_spec **rules)
Retrieve the integrity rules for the current database.
int TdbGetTextSeparators(text_sepa_rec *separatorSpec)
Load a text separator specification.
int TdbDeleteBaseDef()
Delete a previously loaded database design.
int TdbGetFieldProperty(TdbHandle handle, int property_id, int *numeric_value, char *string_value_buffer, int string_buffer_size)
Retrieve a field design property.
int TdbGetBaseFieldGroup(TdbHandle *fgrp_design_handle, TdbHandle base_design_handle, const char *name, int ordinal)
Load a field group definition from a database design.
int TdbDeleteDbCluster(void)
Delete a database cluster.
int TdbGetClusterDesign(TdbHandle *cluster_handle, const char *cluster_name, int access_mode)
Load a database cluster specification.
int TdbPutBaseField(TdbHandle handle)
Store a field specification record.
int TdbDeleteBaseField(TdbHandle *fieldHandle)
Delete a field from a database design.
int TdbGetFieldGroupProperty(TdbHandle handle, int property_id, int *numeric_value, char *string_value_buffer, int string_buffer_size)
Retrieve field group properties.
int TdbCheckThes(const char *thesaurus, int accessMode)
Check access rights to a thesaurus.
int TdbCheckDbCluster(const char *clusterName, int accessMode)
Check access rights to a database cluster.
int TdbGetTermSetTerm(int termsetId, int termNumber, char *termValue, int *length, int *recordCount)
Retrieves a term from a term set.
int TdbCurrentBase(char *base)
Retrieve the name of the currently open database.
int TdbGetDisplay(int *termCount, int *termType)
Retrieve information about the current display list.
int TdbTermSetCount(int termsetId, int64_t *recordCount, int64_t *updateCount)
int TdbExecuteCcl(char *cclorder, int *status)
Execute a CCL order.
int TdbCheckSearch(int *search)
Check that a search with the given number exists.
int TdbUpdateTermSet(int termsetId, const char *shin, int mode)
int TdbSearchInfo(int search_number, int mode, int64_t *integer_value, char *string_buffer, size_t string_buffer_size)
Retrieve information about a search set.
int TdbCreateTermSet(int *termsetId)
Create a term set based on the most recent DISPLAY result.
int TdbGetTermSetTermEx(int termsetId, int termNumber, char *termValue, int *length, int64_t *recordCount, int64_t *updateCount)
Retrieves a term from a term set.
int TdbIndex(const char *base, int recordNumber)
Index a specified record in a database.
int TdbGetParsedCcl(int mode, char **parsed_order, int *length)
Get parsed version of the latest executed CCL order.
int TdbGetDisplayTermEx(int termNumber, char *term, int *termLength, int64_t *recordCount)
Retrieve a term from the current display list.
int TdbCreateBaselineTermSet(int *termsetId, const char *shin, int mode)
int TdbCheckCcl(char *cclorder, int *status)
Performs syntax analysis of a CCL order.
int TdbDidYouMean(char *buffer, int *length)
Retrieve an alternate search expression that may yield better results.
int TdbGetDisplayTerm(int termNumber, char *term, int *termLength, int *recordCount)
Retrieve a term from the current display list.
int TdbBatchLoadIndex(int mode, const char *base, const char *tformFile)
Submit a batch job to load data into a database or index a database.
int TdbDeleteTermSet(int termsetId)
Deletes a term set.
int TdbSetBreakFlag(void)
Tells TRIPsystem to abort an ongoing search.
int TdbLoadAse(char *ase_name, void **ase_id)
Load an ASE routine.
int TdbExport(FilterData *fd)
Calls a filter ASE for export of data from a TRIP database.
int TdbAseRetCode(void)
Get the return code from the most recently called ASE routine.
int TdbCallAse(void *aseID, char *argstr, int *arglen)
Call an ASE routine.
int TdbSetBreakChars(int mask, void(*routine)(int), int mode)
Set the Command Break Characters.
int TdbLoadStatus(int mode)
Reset the TRIP session status.
int TdbSaveStatus(void)
Save the current TRIP session status.
int TdbImport(FilterData *fd)
Calls a filter for import of data into a TRIP database.
int TdbSetComforterInterval(int seconds, void(*proc)(int))
Set the Comforter Interval.
int TdbStrNormalize(char *string, int *length, int mode)
Normalizes a string.
int TdbBreak(void)
Allow an application to detect a user-initiated interrupt signal.
int TdbDeleteItem(TdbHandle cursor)
Delete a data item in a cursor domain.
int TdbGetRecordInSearch(TdbHandle recordControl, int *search, int *RID, char *base)
Load a record from a search result.
int TdbCheckField(TdbHandle recordControl, char *name, int *number, int *type, int *flags)
Check a field for existence in a database design, and read its characteristics if present.
int TdbGetNextHitWord(TdbHandle recordControl, int *part, int *field, int *paragraph, int *item, int *word_position, int *length)
Retrieve the next hit word from a record.
int TdbUndeleteRecordPart(TdbHandle cursor)
Undelete the previously deleted record part.
int TdbItemCount(TdbHandle cursor, int *count)
Retrieve the number of items in a field.
int TdbCursorInfo(TdbHandle cursor, int mode, char *stringValue, int *intValue)
Returns information about a cursor.
int TdbAccumulateSummarization(void *handle, TdbHandle cursor)
Add data to the summarizer.
int TdbDeleteRecordControl(TdbHandle *recordControl)
Delete a record control.
int TdbNextControl(TdbHandle *recordControl)
Load a CONTROL file record.
int TdbStartSummarization(void **handle, int engine_id)
Initialize the text summarization engine.
int TdbDeleteRecordInBase(TdbHandle recordControl)
Delete a record from a database.
int TdbRecordInfo(TdbHandle recordControl, int mode, char *stringValue, int *intValue)
Returns information about a record.
int TdbGetTimeStamp(TdbHandle recordControl, unsigned int *timestamp, int type)
Retrieve the TRIP time stamp of a record.
int TdbPutRecord(TdbHandle recordControl, int *recordId)
Write a record into a database.
int TdbGetSortedRecord(int search_no, TdbHandle rec_ctl, int ris, int *rid, char *base)
Loads a record from a sorted search result.
int TdbHitParts(TdbHandle recordControl, int *parthits, int *partcount, int *partmax)
Retrieve information about part records in a search.
int TdbGetRecordInBase(TdbHandle recordControl, int RID)
Load a record from a database.
int TdbGetBlobBlock(TdbHandle cursor, int blockNr, int blockSize, char *block, int *blockLen)
Retrieve the content of a STRING field.
int TdbCheckSymbol(int *symClass, char *symbol, int *length)
Check a character string for conflict with a reserved word.
int TdbPutFieldInfo(TdbHandle cursor, int buf_len, char *rec_buf)
Assign a value to a TEXT field.
int TdbGetBlobSize(TdbHandle cursor, int *blobSize)
Returns the size of the content of a STRING field.
int TdbInsertItem(TdbHandle cursor, char *data_item, int item_length)
Load a data item from a buffer into a record control area.
int TdbGetHitPart(TdbHandle recordControl, int seqNumber, int *partNumber)
Return Hit Part details.
int TdbGetLine(TdbHandle cursor, char *line, int *line_length, int maximum_length)
Load a text line into a buffer.
int TdbAppendRecordPart(TdbHandle cursor, const char *partName)
Append a record part to the end of the part list for the currently loaded record.
int TdbGetNextItem(TdbHandle cursor, char *data_item, int *length)
Load the next data item into a buffer.
int TdbSortRecords(int searchNumber, char *sortSpecification)
Sort an existing search set.
int TdbCheckPartName(TdbHandle recordControl, int *partID, char *partName)
Retrieve the number or name of a record part.
int TdbPartCount(TdbHandle cursor, int *count)
Returns the number of part records within a record.
int TdbImportBlob(TdbHandle cursor, const char *filename)
Import a binary large object from a file.
int TdbExportBlob(TdbHandle cursor, char *filename)
Export a STring field to a file.
int TdbGetRecordInThes(TdbHandle recordControl, int termNumber, int *level)
Load a record from a thesaurus.
int TdbCheckCursor(TdbHandle cursor, TdbHandle *recordControl, int *field, int *paragraph, int *item)
Check the domain of a cursor object.
int TdbEndSummarization(void *handle)
Ends a summarization run.
int TdbGetFieldInfo(TdbHandle cursor, int *buf_len, char **rec_buf, int *hit_cnt, int **hit_vec, int *para_cnt)
Returns data with original formatting from a field of any kind.
int TdbPutBlobBlock(TdbHandle cursor, int blockLen, char *block)
Write data to a STRING field.
int TdbCurrentItem(char *base, TdbHandle *recordControl, int *record, int *part, int *field, int *paragraph, int *item)
Retrieve information about the current context.
int TdbParaCount(TdbHandle cursor, int *count)
Returns the number of paragraphs within a field.
int TdbSetLinkBase(TdbHandle recordControl, char *base_name, TdbHandle *base_id)
Make a database accessible for data entry linkage.
int TdbEraseRecordControl(TdbHandle recordControl)
Reinitialize a record control.
int TdbGetRecordBuffer(TdbHandle cursor, char *buffer_address, int buffer_length, int part_number, int *filled_length)
Gets the content of a buffer.
int TdbGetRecordInSearchRis(TdbHandle recordControl, int *search, int RIS, int *RID, char *base)
Load a record from a search result, specified by RIS.
int TdbRenameRecordPart(TdbHandle cursor, const char *part_name)
Rename a record part.
int TdbStartControl(char *name)
Set the initial value for reading CONTROL records.
int TdbGetLinkBase(char *base, char *recordNameField)
Load the design of a link database.
int TdbReplaceItem(TdbHandle cursor, char *data_item, int item_length)
Replace a data item in a record control area.
int TdbSetBase(TdbHandle recordControl, char *base, int access_mode)
Set the access mode for a database.
int TdbDeleteCursor(TdbHandle *cursor)
Delete a cursor object.
int TdbCheckRecordName(TdbHandle recordControl, int *recordID, char *name)
Retrieve the record number of a record indicated by name.
int TdbSetRecordPart(TdbHandle *cursor, TdbHandle recordControl, int part_number)
Specify the record part.
int TdbCheckData(TdbHandle recordControl, int field, int item, char *data, int length)
Validate data for a particular field prior to attempting a commit operation.
int TdbValidValues(int field_number, TdbHandle base_id, char *term)
Produce term lists in combination with link databases.
int TdbCreateTimeStamp(unsigned int *tstamp, int type)
Create a time stamp.
int TdbSetCursor(TdbHandle *cursor, TdbHandle recordControl, int field, int paragraph, int item)
Set a cursor domain.
int TdbReleaseRecord(TdbHandle recordControl)
Release a lock on a record.
int TdbPutRecordBuffer(TdbHandle cursor, char *buffer_address, int buffer_len, int *err_partnr, int *err_fieldnr, int *err_itemnr)
Load a TRIP record with TFORM-formatted data.
int TdbSortTerms(int termSetNumber, int sortFlags)
Sorts a display order or term set.
int TdbCheckExistence(TdbHandle recordControl, int field, char *data, int length)
Check for existence of indexed data in a PHRase field.
int TdbLockRecord(TdbHandle recordControl)
Lock the record in the record control area.
int TdbDeleteRecordPart(TdbHandle cursor, int mode)
Delete a record part.
int TdbSortRecordsEx(int searchNumber, const char *sortSpecification, int mode)
Sort an existing search set with clusters and/or record parts.
int TdbPutLine(TdbHandle cursor, char *line, int line_length)
Load a text line from a buffer into a record control area.
int TdbShowControl(int mode, int all_flag, char *name1, char *name2)
Initialize reading of CONTROL records.
int TdbCreateRecordControl(TdbHandle *recordControl)
Create a record control object.
int TdbGetLinkRecord(TdbHandle recordControl, char *record_name, int length)
Load a record from a link database during data entry.
int TdbGetItem(TdbHandle cursor, char *data_item, int *item_length)
Load a data item into a buffer.
int TdbGenerateSummary(void *handle, Char **summary)
Generate a summary.
int TdbGetRecord(TdbHandle recordControl, int mode, int search, int64_t ordinal)
Get a record from a search set or a database.
int TdbInsertRecordPart(TdbHandle cursor, const char *partname)
Insert a record part.
int TdbGraphPathAnalysisStep(int *context)
Perform one iteration of a graph path analysis operation.
int TdbGraphStartPathAnalysis(int **context, int algorithm, int maxDepth, int originSet, int edgeSet, int destinationSet, boolean reverse, const char *condition)
Initialize a graph path analysis operation.
int TdbGraphRecAssoc(TdbHandle *recordControl, const char *recordName, const char *edgeName, TdbHandle sourceRecord, TdbHandle targetRecord, double weight)
Create a graph edge between two existing TRIP records.
int TdbGraphResolve(int *resultSet, int mode, int edgeSet, const char *database)
Create a search set of the vertices associated by the edges in a graph search set.
int TdbGraphGetPath(int *context, char **edge, double *weight, char **database, int *recordId)
Returns information on a path found by a graph analysis operation.
int TdbGraphNextPath(int *context, char **database, int *recordId)
Advances to the next path from a completed analysis result.
int TdbGraphAddVertex(TdbHandle *recordControl, const char *recordName, const char *label, TdbHandle referenceRecord)
Create a simple in-graph vertex record.
int TdbGraphAnalysisSnapshot(int *context, int *count, int mode)
Returns path count statistics from an on-going analysis.
int TdbGraphFind(int *resultSet, int sourceSet, int edgeSet, int targetSet, int exclusionSet, const char *condition)
Locate the direct relationships between two sets of records.
int TdbGraphClosePathAnalysis(int **context)
Terminate a graph path analysis operation and release any resources allocated to it.
int TdbGraphTransitive(int *resultSet, int maxDepth, boolean reverse, boolean allEdges, int edgeSet, int sourceSet, int targetSet, const char *condition)
Perform a transitive search in a graph datanase.
int TdbGetUserProfile(char *user, user_profile_rec *profile)
Retrieve the profile record for a TRIP user.
int TdbDeleteUser(const char *user)
Delete a TRIP user ID.
int TdbGetGroupName(char *groupName, int gid)
Get the group name for a group specified by number.
int TdbGetGroup(char *group, int *memberCount)
int TdbPutUserProfile(user_profile_rec *profileRecord)
Store the profile record for a TRIP user.
int TdbChangeUm(const char *old_um, const char *new_um, const char *user_group)
Change the user manager for a TRIP user or group.
int TdbCreateUser(const char *username, const char *password)
Create a new user.
int TdbDeleteMember(const char *group, const char *user)
Delete a user from a group.
int TdbGetMembers(char *members, int *length)
Retrieve the members of a group.
int TdbSystemMode(const char *password)
Switch to TRIP System ID.
int TdbDeleteGroup(const char *group)
Delete a user group.
int TdbChangeFm(const char *old_fm, const char *new_fm, const char *base)
Transfers ownership of a database from one user to another.
int TdbOsUser(char *OSuser, int *length)
Retrieve the current O/S user ID.
int TdbPutUserRights(boolean UM, boolean FM)
Set the manager rights for a TRIP user.
int TdbCheckMember(const char *group, const char *user)
Check a user for membership of a group.
int TdbGetUserRights(const char *user, boolean *UM, boolean *FM)
Retrieve the manager rights for a TRIP user.
int TdbAddMember(const char *group, const char *user)
Inserts a TRIP username into the membership list of a group.
int TdbChangePassword(const char *oldpass, const char *newpass)
Change password for the current user.
int TdbCreateGroup(const char *group)
Create a user group.
int TdbSetPassword(const char *user, const char *password)
Set a user password.
int TdbTdbsUser(char *userName, int *length)
Retrieve the current TRIP user ID.
int TdbBaffitMode(void)
Return the mode in which the current record is being processed.
int TdbLanguage(char *language)
Retrieve current language code.
int TdbUserInfo(int mode, char *stringValue, int *intValue)
This routine returns information about the currently logged on user.
int TdbLicenseInfo(int mode, const char *strarg, char *stringValue, size_t strvalsz, int *intValue)
Returns information about the the TRIP license.
int TdbCurrentDate(char *date, int *length)
Retrieve the current date.
int TdbFieldInfo(TdbHandle cursor, int mode, char *cvalue, int *ivalue)
Returns various data about a field in a database.
int TdbCurrentTime(char *timestr, int *length)
Retrieve the current time.
int TdbGetQueuedMessage(char *message, int *length, char *logfile)
Retrieve a job status message from the TRIPdaemon message queue.
int TdbShellSymbol(char *symbol, int *symbol_length)
Check or retrieve CCL keywords.
int TdbVersion(char *version, int *version_length)
Return the current TRIP version.
int TdbSessionInfo(int mode, char *stringValue, int *intValue)
Returns information about the current session.
int TdbPutJsonFile(TdbHandle recordControl, const char *jsonfile)
int TdbGetXmlBuffer(TdbHandle recordControl, char **xmldata, int *length)
int TdbGetXmlFragments(int searchSetNo, const char *xpath, int startRis, int endRis, boolean highlight, void **buffer, int *length)
int TdbPutXmlFile(TdbHandle recordControl, boolean storeCopy, boolean validate, const char *xmlfile)
int TdbPutJsonBuffer(TdbHandle recordControl, const char *jsondata, int length)
int TdbExecuteXPath(const char *xpath, int *searchSet)
int TdbPutXmlBuffer(TdbHandle recordControl, boolean storeCopy, boolean validate, const char *xmldata, int length)
int TdbGetJsonBuffer(TdbHandle recordControl, char **jsondata, int *length)
int TdbDeallocate(void *buf)
Release member returned by various other kernel API functions.
int TdbExtractTextFromMem(TdbHandle recordControl, int partNumber, const char *targetFieldName, const char *propertyNameField, const char *propertyValueField, const char *targetStringFieldName, unsigned char *filedata, size_t fileDataSize, const char *fileName)
Call TRIPcof to extract text from in-memory file data.
int TdbExtractTextFromField(TdbHandle recordControl, int partNumber, const char *targetFieldName, const char *propertyNameField, const char *propertyValueField, const char *sourceFieldName, const char *fileName)
Call TRIPcof to extract text from file data stored in a STRING field.
int TdbOpenBase(char *base)
Make a database known to TRIP.
int TdbExtractTextFromFile(TdbHandle recordControl, int partNumber, const char *targetTextFieldName, const char *propertyNameField, const char *propertyValueField, const char *targetStringFieldName, const char *fileName)
Call TRIPcof to extract text from a file on the local file system.
int TdbOpenBaseQuota(int *bases)
Retrieve the number of bases which can be opened.
int TdbShellToDao(shell_dao_rec *shell_dao)
Parse a CCL command.
int TdbShellInit(int language)
Initialize the CCL parser.
int TdbEndTdbs(boolean restart)
Terminates a TRIP session started with TdbBeginTdbs.
int TdbGetSearch(int *search, int *record_count, int *hit_count)
Obtain search result information.
int TdbGetSessionInfo(char *run_time, Char *logged_in, Char *FM, Char *UM, Char *SM)
Get information about the current TRIP session.
int TdbGetThesDef(char *thesaurus, base_spec_rec *thesaurusSpec)
Load a thesaurus definition.
int TdbGetDbCluster(char *cluster, cluster_spec_rec *clusterSpecification)
Load a database cluster specification.
int TdbPutDbCluster(cluster_spec_rec *clusterSpec)
Store a database cluster specification.
int TdbDefineXml(boolean xml)
XML enable a database design.
int TdbPutBaseDef(base_spec_rec *baseSpec)
Store a database definition.
int TdbShellDaoPtr(shell_dao_rec **shell_dao)
Retrieve the address of a shell dao record.
int TdbDeleteFieldSpec(field_spec_rec *fldspec)
Delete a field specification from a database design.
int TdbDefineGraph(base_spec_rec *base_spec, boolean enable)
Graph-enable a database design.
int TdbDaoOrder(int *order)
Execute a DAO order.
int TdbGetFieldName(field_spec_rec *field_specification, int ordinal)
Load the name of a field.
int TdbCopyThesDef(const char *old_thes, const char *new_thes, base_spec_rec *thes_specification)
Create a copy of a thesaurus definition.
int TdbGetFieldSpec(field_spec_rec *fieldSpec)
Load a field specification record.
int TdbPutThesDef(base_spec_rec *thesaurusSpec)
Store a thesaurus definition.
int TdbSearchResult(int *searchNumber, int *recordCount, int *hitCount, char **cclOrder, int *length)
Returns information about a conducted search.
int TdbGetBaseInfo(char *base, char *recordNameField, int *flags)
Get record name field and other information about the database.
int TdbBeginTdbs(shell_dao_rec *shell_dao, boolean restart)
Initialize TRIP for a new session or resume a previous session.
int TdbGetDefragStatus(const char *base, boolean *baf, boolean *bif, boolean *vif)
Check the specified database files for need of defragmentation.
int TdbPutFieldSpec(field_spec_rec *fieldSpec)
Store a field specification record.
int TdbGetBaseDef(char *base, base_spec_rec *baseSpecification)
Load a database definition.
int TdbNextRunCommand(void)
Load the next command in a stored procedure.
int TdbCopyBaseDef(char *old_base, char *new_base, base_spec_rec *base_specification)
Create a copy of a database definition.
int TdbClearRunStack(void)
Clear the stack of running procedures, effectively doing a jump from any nesting level back to the to...
int TdbGetProcLine(char *line, int *lineLength)
Load a macro/procedure line.
int TdbDeleteProcedure(char *procedure)
Delete a TRIP macro/procedure.
int TdbPutProcedure(void)
Store a TRIP macro or procedure.
int TdbGetNextProcLine(char **line, int *length)
Returns the next line to be executed out of a procedure.
int TdbCopyProcedure(char *oldProcedure, char *newProcedure)
Create a copy of a procedure.
int TdbPutProcLine(char *line, int lineLength)
Load a macro/procedure line into an internal buffer.
int TdbContinue(void)
Check if continuation on error has been defined.
int TdbGetProcedure(char *procedure)
Load a TRIP macro or procedure.
int TdbCheckOutputFormat(void)
Check the syntax of an output format.
int TdbDeleteOutputFormat(char *base, char *format)
Delete an output format.
int TdbGetFormLine(char *line, int *lineLength)
Load a format line.
int TdbPutOutputFormat(void)
Store an output format.
int TdbGetComment(char *comment)
Load the description of a CONTROL record.
int TdbGetOutputFormat(char *base, char *format)
Load an output format.
int TdbPutFormLine(char *line, int lineLength)
Load a format line into an internal format buffer.
int TdbCurrentForm(char *base, char *form, int mode)
Retrieve the name of the current defined default entry or output form.
int TdbPutComment(char *comment)
Store the description of a CONTROL record.
int TdbCopyOutputFormat(char *old_base, char *old_form, char *new_base, char *new_form, int *error)
Create a copy of an output format.
int TdbResolvePath(const char *symbolPath, char *resolved, size_t bufsize)
int TdbShellType(char *fieldtypeName, int *fieldtypeNumber)
Check a field type on its name or number.
int TdbMessage(int messageNumber, char *message, int *length)
Retrieve the text of a TRIP message indicated by number, or display a message.
int TdbSetConf(const char *symbolName, const char *symbolValue)
int TdbCheckUser(const char *user, const char *password, char *FM, char *UM, char *SM)
Perform a login operation to the TRIPkernel by validating both username and password.
int TdbCheckDate(int dateform, char *datestring, int *dateint)
Checks that a supplied date is valid and transforms date strings to integers and vice versa.
int TdbApiLogRead(int checkpoint_id, long *position, char *buffer, size_t bufsize, size_t *readcount)
Read data from the API log.
int TdbApiLogCheckpoint(int id)
Sets an API log checkpoint position.
int TdbRetCode(void)
Return the TRIP message number.
int TdbShellDefDateform(int dateform, char *datestring)
Get or set a TRIP date format.
int TdbApiLogEnable(boolean enable)
Enables or disables API logging for the current session.
int TdbDeleteTicket(const char *ticket)
Delete login ticket(s) for the currently logged in user,.
int TdbApiLogSetVerbosity(int level)
Set verbosity level for the API log.
int TdbShellModifyCcl(int language)
Modify the CCL locale language being used.
int TdbSetUICharset(int charset)
Change the session character set.
int TdbCreateTicket(char *ticket, int maxlen)
Create a login ticket for the currently logged in user.
int TdbStartTrip(char *username, char *password, int language, int mode)
Initializes the client application for a new TRIP session.
int TdbGetConf(const char *symbolName, int section, char *valueBuffer, size_t bufferSize, const char *defaultValue)
Get a configuration symbol value.
int TdbChangeUser(const char *user, const char *password, int mode)
Change the currently logged on user, or temporarily logs out the current user.
int TdbStopTrip(boolean restart)
Terminates a TRIP session started with TdbStartTrip.
int TdbIsSuperUser(void)
Check if current user has SUPERMAN privileges.
int TdbGetWindowInfo(int windowType, char **windowBuffer, int *rowSize, int *colSize, int *rowCount, int *flags)
Load all lines from a TRIP window.
int TdbDefineWindow(int windowType, int height, int width)
Define a kernel window buffer for formatted output.
int TdbGetWindowType(int windowId, int *windowType)
Returns the window type for a window.
int TdbGetWindowHits(int windowType, int *hitCount, int **windowHits)
Return hit words in a TRIP window.
int TdbGetWindowLine(int windowType, char *line)
Load a formatted line from a TRIP window.
int TdbCheckScreenWindow(int windowType, int *windowId)
Retrieve the identifier of a kernel output window.
int TdbSetScreenWindow(int windowType, int windowNumber)
Set the identifier of a kernel output window.
int TdbDeleteWindow(int windowNumber)
Deletes the specified TRIP kernel window.
int TdbGetWindowHit(int windowType, int *linePosition, int *length)
Retrieve the next hit word in a formatted line.
Database access record.
Definition tripapi_types.h:178
Database integrity rule specification.
Definition tripapi_types.h:293
Structure definition for a database.
Definition tripapi_types.h:77
Structure used for defining clusters of databases.
Definition tripapi_types.h:191
Definition of a field's design properties.
Definition tripapi_types.h:134
Structure used with TdbImport and TdbExport.
Definition tripapi_types.h:240
Shell/DAO interface record.
Definition tripapi_types.h:62
Definition of sentence / paragraph boundary markers.
Definition tripapi_types.h:116
Structure used for defining user properties.
Definition tripapi_types.h:202