TRIPsystem Kernel API 8.4
Loading...
Searching...
No Matches
tripapi.h
1
6
7#ifndef __TRIPAPI_PROTOTYPES__
8#define __TRIPAPI_PROTOTYPES__
9
10#include <stdio.h>
11#include <time.h>
12
13/* Macros for compiler-specific deprecation signaling */
14#ifdef __cplusplus
15#if __cplusplus >= 201300
16#define TDB_DEPRECATED(msg) [[deprecated(msg)]]
17#endif
18#endif
19#ifndef TDB_DEPRECATED
20#ifdef _MSC_VER
21#define TDB_DEPRECATED(msg) __declspec(deprecated(msg))
22#elif defined(__GNUC__) || defined(__clang__)
23#define TDB_DEPRECATED(msg) __attribute__((deprecated))
24#else
25#define TDB_DEPRECATED(msg)
26#endif
27#endif
28
29/* Include the kernel structure and constant definitions required */
30#include "tripapi_defs.h"
31#include "tripapi_types.h"
32
33#if defined(__cplusplus)
34extern "C" {
35#endif
36
45
46
70 int TdbApiLogEnable(boolean enable);
71
91
115 int TdbApiLogRead(int checkpoint_id, long* position, char* buffer,
116 size_t bufsize, size_t* readcount);
117
145 int TdbApiLogSetVerbosity(int level);
146
249 int TdbCheckDate(int dateform, char* datestring, int* dateint);
250
251
343 int TdbCheckUser(const char* user, const char* password, char* FM, char* UM, char* SM);
344
396 int TdbChangeUser(const char* user, const char* password, int mode);
397
420 int TdbSetUICharset(int charset);
421
451 int TdbCreateTicket(char* ticket, int maxlen);
452
465 int TdbDeleteTicket(const char* ticket);
466
467
518 int TdbCreateTokenPair(const char* apikey,
519 const char* user, const char* tag,
520 char** access_token, int* access_token_length,
521 char** refresh_token, int* refresh_token_length,
522 time_t* access_expires_at, time_t* refresh_expires_at);
523
573 int TdbRefreshTokenPair(const char* apikey,
574 const char* current_refresh_token,
575 char** access_token, int* access_token_length,
576 char** refresh_token, int* refresh_token_length,
577 time_t* access_expires_at, time_t* refresh_expires_at,
578 char* username, size_t username_size);
579
629 int TdbPurgeUserTokens(int mode, const char* username,
630 time_t from_fimestamp, time_t to_timestamp, int* purgedcount,
631 FP_TdbPurgeTokensCallback callback, void* userdata);
632
681 int TdbPurgeTokens(int mode,
682 time_t from_timestamp, time_t to_timestamp, int* purgedcount,
683 FP_TdbPurgeTokensCallback callback, void* userdata);
684
723 int TdbRevokeTokens(const char* username, const char* token, const char* tag,
724 int* revokecount, FP_TdbPurgeTokensCallback callback, void* userdata);
725
767 int TdbEnumUserTokens(const char* username, void** handle,
768 char* tag, size_t tag_size,
769 time_t* created, time_t* access_expires_at,
770 time_t* refresh_expires_at);
771
813 int TdbEnumTokens(void** handle, char* user, size_t user_size,
814 char* tag, size_t tag_size, time_t* created,
815 time_t* access_expires_at, time_t* refresh_expires_at);
816
849 int TdbCreateApiKey(const char* keyname, const char* comment,
850 boolean replace, char** keybuf, int* keybuf_size);
851
874 int TdbRevokeApiKey(const char* keyname);
875
916 int TdbApiKeyInfo(const char* keyname, int mode,
917 char* outstr, size_t outstrsz, int* outint);
918
925 int TdbCheckApiKey(const char* apikey);
926
942 int TdbEnumApiKeys(void** handle,
943 char* keyname, size_t keyname_size,
944 char* comment, size_t comment_size,
945 char* creator, size_t creator_size,
946 char* credate, size_t credate_size,
947 char* cretime, size_t cretime_size);
948
1005 int TdbMessage(int messageNumber, char* message, int* length);
1006
1007
1022 int TdbRetCode(void);
1023
1024
1038
1039
1093 int TdbShellDefDateform(int dateform, char* datestring);
1094
1095
1130 int TdbShellModifyCcl(int language);
1131
1132
1175 int TdbShellType(char* fieldtypeName, int* fieldtypeNumber);
1176
1177
1296 int TdbStartTrip(char* username, char* password, int language, int mode);
1297
1298
1299
1334 int TdbStopTrip(boolean restart);
1335
1358 int TdbGetConf(const char* symbolName, int section,
1359 char* valueBuffer, size_t bufferSize,
1360 const char* defaultValue);
1361
1369 int TdbSetConf(const char* symbolName, const char* symbolValue);
1370
1371
1384 int TdbResolvePath(const char* symbolPath, char* resolved, size_t bufsize);
1385
1386
1387 // ------------------------------------------------------------------------
1388
1396
1397
1403
1457 int TdbBatchLoadIndex(int mode, const char* base, const char* tformFile);
1458
1515 int TdbSubmitBatchJob(int* jobid, int jobtype, const char* base, const char* tform);
1516
1568 int TdbIndex(const char* base, int recordNumber);
1569
1570 // END OF BATCH COMMANDS BLOCK
1572
1577
1578
1609 int TdbCheckCcl(char* cclorder, int* status);
1610
1611
1690 int TdbExecuteCcl(char* cclorder, int* status);
1691
1692
1712 int TdbDidYouMean(char* buffer, int* length);
1713
1714
1739 int TdbGetParsedCcl(int mode, char** parsed_order, int* length);
1740
1741
1742 // END OF CCL COMMANDS BLOCK
1744
1745
1750
1751
1779 int TdbCheckSearch(int* search);
1780
1781
1822 int TdbSearchInfo(int search_number, int mode, int64_t* integer_value,
1823 char* string_buffer, size_t string_buffer_size);
1824
1825 // END OF SEARCH SETS BLOCK
1827
1828
1857 int TdbCurrentBase(char* base);
1858
1859
1864
1894 int TdbCreateTermSet(int* termsetId);
1895
1921 int TdbDeleteTermSet(int termsetId);
1922
1952 int TdbCreateBaselineTermSet(int *termsetId, const char *shin, int mode);
1953
1979 int TdbUpdateTermSet(int termsetId, const char *shin, int mode);
1980
1981
1994 int TdbTermSetCount(int termsetId, int64_t* recordCount, int64_t* updateCount);
1995
1996
2038 int TdbGetDisplay(int* termCount, int* termType);
2039
2040
2080 int TdbGetDisplayTerm(int termNumber, char* term, int* termLength,
2081 int* recordCount);
2082
2083
2113 int TdbGetDisplayTermEx(int termNumber, char* term, int* termLength,
2114 int64_t* recordCount);
2115
2116
2164 int TdbGetTermSetTerm(int termsetId, int termNumber, char* termValue,
2165 int* length, int* recordCount);
2166
2167
2222 int TdbGetTermSetTermEx(int termsetId, int termNumber, char* termValue,
2223 int* length, int64_t* recordCount,
2224 int64_t* updateCount);
2225
2226
2228
2229
2230 // ------------------------------------------------------------------------
2231
2240
2241
2288 int TdbCheckScreenWindow(int windowType, int* windowId);
2289
2290
2339 int TdbDefineWindow(int windowType, int height, int width);
2340
2341
2361 int TdbDeleteWindow(int windowNumber);
2362
2363
2405 int TdbGetWindowHit(int windowType, int* linePosition, int* length);
2406
2407
2408
2455 int TdbGetWindowHits(int windowType, int* hitCount, int** windowHits);
2456
2457
2517 int TdbGetWindowInfo(int windowType, char** windowBuffer, int* rowSize,
2518 int* colSize, int* rowCount, int* flags);
2519
2520
2568 int TdbGetWindowLine(int windowType, char* line);
2569
2570
2602 int TdbGetWindowType(int windowId, int* windowType);
2603
2604
2652 int TdbSetScreenWindow(int windowType, int windowNumber);
2653
2654
2655 // ------------------------------------------------------------------------
2656
2665
2666
2687
2688
2709 int TdbContinue(void);
2710
2711
2712
2745 int TdbCopyProcedure(char* oldProcedure, char* newProcedure);
2746
2747
2775 int TdbDeleteProcedure(char* procedure);
2776
2777
2802 int TdbGetNextProcLine(char** line, int* length);
2803
2804
2805
2844 int TdbGetProcLine(char* line, int* lineLength);
2845
2846
2847
2879 int TdbGetProcedure(char* procedure);
2880
2881
2882
2924 int TdbPutProcLine(char* line, int lineLength);
2925
2926
2949
2950
2951 // ------------------------------------------------------------------------
2952
2960
2961
3014 int TdbAddMember(const char* group, const char* user);
3015
3016
3062 int TdbChangeFm(const char* old_fm, const char* new_fm, const char* base);
3063
3064
3088 int TdbChangePassword(const char* oldpass, const char* newpass);
3089
3090
3135 int TdbChangeUm(const char* old_um, const char* new_um, const char* user_group);
3136
3137
3177 int TdbCheckMember(const char* group, const char* user);
3178
3179
3213 int TdbCreateGroup(const char* group);
3214
3215
3247 int TdbCreateUser(const char* username, const char* password);
3248
3249
3275 int TdbDeleteGroup(const char* group);
3276
3277
3320 int TdbDeleteMember(const char* group, const char* user);
3321
3322
3323
3359 int TdbDeleteUser(const char* user);
3360
3361
3395 int TdbGetGroup(char* group, int* memberCount);
3396
3397
3422 int TdbGetGroupName(char* groupName, int gid);
3423
3424
3454 int TdbGetMembers(char* members, int* length);
3455
3456
3497 int TdbGetUserProfile(char* user, user_profile_rec* profile);
3498
3499
3543 int TdbGetUserRights(const char* user, boolean* UM, boolean* FM);
3544
3545
3576
3577
3623 int TdbPutUserRights(boolean UM, boolean FM);
3624
3625
3651 int TdbOsUser(char* OSuser, int* length);
3652
3653
3686 int TdbSetPassword(const char* user, const char* password);
3687
3688
3715 int TdbSystemMode(const char* password);
3716
3717
3745 int TdbTdbsUser(char* userName, int* length);
3746
3747
3748 // ------------------------------------------------------------------------
3749
3757
3758
3763
3764
3833 int TdbBaseInfo(const char* base, int mode, char* cvalue, int* ivalue);
3834
3835
3873 int TdbClusterInfo(int mode, const char* cluster, char* outstr, size_t outstrsz, int64_t* outint);
3874
3875
3931 int TdbBaseStatus(const char* base, char* revisionDate, char* indexDate,
3932 int* recordCount);
3933
3934
3935 // END OF GENERAL DB FUNCTIONS BLOCK
3937
3938
3943
3996 int TdbCheckBase(const char* base, int accessMode);
3997
3998
4042 int TdbCheckDbCluster(const char* clusterName, int accessMode);
4043
4044
4091 int TdbCheckThes(const char* thesaurus, int accessMode);
4092
4093
4137 int TdbGetDbAccess(char* user, base_access_rec* baseAccess);
4138
4139
4180
4181
4182 // END OF DB ACCESS FUNCTIONS BLOCK
4184
4185
4190
4204 int TdbCheckFieldName(const char* field_name);
4205
4206
4260 int TdbCopyBaseDesign(const char* from_base, const char* to_base,
4261 TdbHandle* design);
4262
4263
4300
4301
4337 int TdbPutBaseDesign(TdbHandle handle);
4338
4369
4370
4402
4403
4450 int TdbGetBaseDesign(TdbHandle* handle, const char* base, int accessMode);
4451
4452
4467 int TdbCloseBaseDesign(TdbHandle* handle);
4468
4469
4519 int TdbGetBaseProperty(TdbHandle handle, int property_id, int* numeric_value,
4520 char* string_value_buffer, int string_buffer_size);
4521
4598 int TdbPutBaseProperty(TdbHandle handle,int property_id, int numeric_value,
4599 const char* string_value);
4600
4601
4602 // END OF DB DESIGN FUNCTIONS BLOCK
4604
4609
4610
4665 int TdbGetBaseField(TdbHandle* fieldHandle, TdbHandle baseHandle,
4666 const char* fieldName, int ordinal);
4667
4668
4669
4717 int TdbGetBaseFieldByNumber(TdbHandle* fieldHandle, TdbHandle baseHandle,
4718 int fieldNumber);
4719
4761 int TdbDeleteBaseField(TdbHandle* fieldHandle);
4762
4763
4830 int TdbPutBaseField(TdbHandle handle);
4831
4832
4856 int TdbCloseBaseField(TdbHandle* handle);
4857
4931 int TdbGetFieldProperty(TdbHandle handle, int property_id,
4932 int* numeric_value, char* string_value_buffer,
4933 int string_buffer_size);
4934
5017 int
5018 TdbPutFieldProperty(TdbHandle field_design_handle,int property_id,
5019 int numeric_value, const char* string_value);
5020
5021
5022 // END OF DB FIELD FUNCTIONS BLOCK
5024
5029
5052 int
5053 TdbGetBaseFieldGroup(TdbHandle* fgrp_design_handle,
5054 TdbHandle base_design_handle,
5055 const char* name, int ordinal);
5056
5082 int TdbPutBaseFieldGroup(TdbHandle handle);
5083
5084
5106 int TdbCloseBaseFieldGroup(TdbHandle* handle);
5107
5134 int TdbDeleteBaseFieldGroup(TdbHandle* handle);
5135
5165 int
5166 TdbGetFieldGroupProperty(TdbHandle handle, int property_id,
5167 int* numeric_value,
5168 char* string_value_buffer, int string_buffer_size);
5169
5195 int
5196 TdbPutFieldGroupProperty(TdbHandle handle, int property_id,
5197 int numeric_value, const char* string_value);
5198
5226 int
5227 TdbFieldGroupAddField(TdbHandle handle, const char* field_name);
5228
5252 int TdbFieldGroupDelField(TdbHandle handle, const char* field_name);
5253
5279 int
5280 TdbFieldGroupGetField(TdbHandle field_group_handle,
5281 TdbHandle* field_handle,
5282 const char* field_name,
5283 int ordinal);
5284 // END OF DB FIELD GROUP FUNCTIONS BLOCK
5286
5287
5294
5318
5333
5350
5359 int TdbCheckForeignKey(Char* keyfield, Char* parentdb, Char* parentfld);
5360
5395 int TdbSetForeignKey(Char* keyfield, Char* parentdb, Char* parentfld, int upd, int del);
5396
5412 int TdbDeleteForeignKey(Char* keyfield);
5413
5437 int TdbGetDefaultValue(Char* fieldName, Char* fieldValue,
5438 int* fieldLength);
5439
5460 int TdbPutDefaultValue(Char* fieldName, Char* fieldValue);
5461
5476 int TdbDeleteDefaultValue(Char* fieldName);
5477
5478 // END OF REFERERENTIAL INTEGRITY FUNCTIONS BLOCK
5480
5481
5486
5517 int TdbCopyThesDesign(const char* from_thes, const char* to_thes,
5518 TdbHandle* design);
5519
5520
5547
5594 int TdbGetThesDesign(TdbHandle* handle, const char* name, int accessMode);
5595
5629 int TdbPutThesDesign(TdbHandle handle);
5630 // END OF THES DESIGN FUNCTIONS BLOCK
5632
5633
5638
5665
5666
5714 int TdbGetClusterDesign(TdbHandle* cluster_handle,
5715 const char* cluster_name,
5716 int access_mode);
5717
5718
5757 int TdbPutClusterDesign(TdbHandle handle);
5758
5759
5774 int TdbCloseClusterDesign(TdbHandle* handle);
5775
5776
5806 int TdbCopyClusterDesign(TdbHandle sourceHandle, const char* newName,
5807 TdbHandle* targetHandle);
5808
5831 int TdbClusterAddMember(TdbHandle handle, const char* name);
5832
5833
5856 int TdbClusterDelMember(TdbHandle handle, int position, const char* name);
5857
5858
5878 int TdbClusterDelMembers(TdbHandle handle);
5879
5914 int TdbClusterEnumMembers(TdbHandle handle, int* position,
5915 char* name, int namesize);
5916
5917
5938 int TdbClusterGetMember(TdbHandle handle, int position,
5939 char* name, int namesize);
5940
5967 int TdbGetClusterProperty(TdbHandle handle, int property_id,
5968 int* numeric_value, char* string_value_buffer,
5969 int string_buffer_size);
5970
5971
5996 int TdbPutClusterProperty(TdbHandle handle, int property_id,
5997 int numeric_value, const char* string_value);
5998 // END OF CLUSTER FUNCTIONS BLOCK
6000
6001
6002
6003
6004 // ------------------------------------------------------------------------
6005
6013
6035
6036
6077 int TdbCurrentForm(char* base, char* form, int mode);
6078
6079
6133 int TdbCopyOutputFormat(char* old_base, char* old_form, char* new_base,
6134 char* new_form, int* error);
6135
6136
6171 int TdbDeleteOutputFormat(char* base, char* format);
6172
6173
6198 int TdbGetComment(char* comment);
6199
6200
6231 int TdbGetFormLine(char* line, int* lineLength);
6232
6233
6266 int TdbGetOutputFormat(char* base, char* format);
6267
6268
6295 int TdbPutComment(char* comment);
6296
6297
6338 int TdbPutFormLine(char* line, int lineLength);
6339
6340
6367
6368
6369 // ------------------------------------------------------------------------
6370
6378
6379
6430 int TdbAppendRecordPart(TdbHandle cursor, const char* partName);
6431
6432
6485 int TdbCheckCursor(TdbHandle cursor, TdbHandle* recordControl,
6486 int* field, int* paragraph, int* item);
6487
6488
6548 int TdbCheckData(TdbHandle recordControl, int field, int item, char *data,
6549 int length);
6550
6551
6604 int TdbCheckExistence(TdbHandle recordControl, int field, char *data,
6605 int length);
6606
6607
6690 int TdbCheckField(TdbHandle recordControl, char* name, int* number,
6691 int* type, int* flags);
6692
6693
6754 int TdbCheckPartName(TdbHandle recordControl, int* partID, char* partName);
6755
6756
6799 int TdbCheckRecordName(TdbHandle recordControl, int* recordID, char* name);
6800
6801
6860 int TdbCheckSymbol(int* symClass, char* symbol, int* length);
6861
6862
6863
6918 int TdbCreateRecordControl(TdbHandle* recordControl);
6919
6920
6949 int TdbCreateTimeStamp(unsigned int* tstamp, int type);
6950
6951
7016 int TdbCurrentItem(char* base, TdbHandle* recordControl, int* record,
7017 int* part, int* field, int* paragraph, int* item);
7018
7019
7050 int TdbDeleteCursor(TdbHandle* cursor);
7051
7052
7082 int TdbDeleteItem(TdbHandle cursor);
7083
7084
7117 int TdbDeleteRecordControl(TdbHandle* recordControl);
7118
7119
7156 int TdbDeleteRecordInBase(TdbHandle recordControl);
7157
7158
7200 int TdbDeleteRecordPart(TdbHandle cursor, int mode);
7201
7202
7232 int TdbEraseRecordControl(TdbHandle recordControl);
7233
7234
7266 int TdbExportBlob(TdbHandle cursor, char* filename);
7267
7268
7317 int TdbGetBlobBlock(TdbHandle cursor, int blockNr, int blockSize,
7318 char* block, int* blockLen);
7319
7320
7350 int TdbGetBlobSize(TdbHandle cursor, int* blobSize);
7351
7352
7396 int TdbGetHitPart(TdbHandle recordControl, int seqNumber, int* partNumber);
7397
7398
7434 int TdbGetItem(TdbHandle cursor, char* data_item, int* item_length);
7435
7436
7481 int TdbGetLine(TdbHandle cursor, char* line, int* line_length,
7482 int maximum_length);
7483
7484
7516 int TdbGetLinkBase(char* base, char* recordNameField);
7517
7518
7555 int TdbGetLinkRecord(TdbHandle recordControl, char* record_name,
7556 int length);
7557
7558
7614 int TdbGetNextHitWord(TdbHandle recordControl, int* part, int* field,
7615 int* paragraph, int* item, int* word_position,
7616 int* length);
7617
7618
7663 int TdbGetNextItem(TdbHandle cursor, char* data_item, int* length);
7664
7665
7732 int TdbGetRecord(TdbHandle recordControl, int mode, int search,
7733 int64_t ordinal);
7734
7735
7777 int TdbGetRecordBuffer(TdbHandle cursor, char* buffer_address,
7778 int buffer_length, int part_number,
7779 int* filled_length);
7780
7781
7841 TDB_DEPRECATED("Deprecated by TdbGetRecord")
7842 int TdbGetRecordInBase(TdbHandle recordControl, int RID);
7843
7844
7904 TDB_DEPRECATED("Deprecated by TdbGetRecord")
7905 int TdbGetRecordInSearch(TdbHandle recordControl, int* search, int* RID,
7906 char* base);
7907
7908
7970 TDB_DEPRECATED("Deprecated by TdbGetRecord")
7971 int TdbGetRecordInSearchRis(TdbHandle recordControl, int* search, int RIS,
7972 int* RID, char* base);
7973
7974
8027 int TdbGetRecordInThes(TdbHandle recordControl, int termNumber, int* level);
8028
8029
8089 TDB_DEPRECATED("Deprecated by TdbGetRecord")
8090 int TdbGetSortedRecord(int search_no, TdbHandle rec_ctl, int ris,
8091 int* rid, char* base);
8092
8093
8135 int TdbGetTimeStamp(TdbHandle recordControl, unsigned int* timestamp,
8136 int type);
8137
8138
8174 int TdbHitParts(TdbHandle recordControl, int* parthits, int* partcount,
8175 int* partmax);
8176
8177
8213 int TdbImportBlob(TdbHandle cursor, const char* filename);
8214
8215
8261 int TdbInsertItem(TdbHandle cursor, char* data_item, int item_length);
8262
8263
8264
8301 int TdbInsertRecordPart(TdbHandle cursor, const char* partname);
8302
8303
8336 int TdbItemCount(TdbHandle cursor, int* count);
8337
8338
8382 int TdbLockRecord(TdbHandle recordControl);
8383
8384
8416 int TdbNextControl(TdbHandle* recordControl);
8417
8418
8456 int TdbPutBlobBlock(TdbHandle cursor, int blockLen, char* block);
8457
8458
8521 int TdbPutLine(TdbHandle cursor, char* line, int line_length);
8522
8523
8551 int TdbParaCount(TdbHandle cursor, int* count);
8552
8553
8586 int TdbPartCount(TdbHandle cursor, int* count);
8587
8588
8677 int TdbPutRecord(TdbHandle recordControl, int* recordId);
8678
8679
8751 int TdbPutRecordBuffer(TdbHandle cursor, char* buffer_address,
8752 int buffer_len, int* err_partnr, int* err_fieldnr,
8753 int* err_itemnr);
8754
8755
8807 int TdbRecordInfo(TdbHandle recordControl, int mode, char* stringValue,
8808 int* intValue);
8809
8810
8854 int TdbCursorInfo(TdbHandle cursor, int mode, char* stringValue,
8855 int* intValue);
8856
8857
8891 int TdbReleaseRecord(TdbHandle recordControl);
8892
8893
8929 int TdbRenameRecordPart(TdbHandle cursor, const char* part_name);
8930
8931
8985 int TdbReplaceItem(TdbHandle cursor, char* data_item, int item_length);
8986
8987
9044 int TdbSetBase(TdbHandle recordControl, char* base, int access_mode);
9045
9046
9107 int TdbSetCursor(TdbHandle* cursor, TdbHandle recordControl, int field,
9108 int paragraph, int item);
9109
9110
9163 int TdbSetLinkBase(TdbHandle recordControl, char* base_name,
9164 TdbHandle* base_id);
9165
9166
9207 int TdbSetRecordPart(TdbHandle* cursor, TdbHandle recordControl,
9208 int part_number);
9209
9210
9286 int TdbShowControl(int mode, int all_flag, char* name1, char* name2);
9287
9288
9329 int TdbSortTerms(int termSetNumber, int sortFlags);
9330
9331
9368 int TdbSortRecords(int searchNumber, char* sortSpecification);
9369
9370
9425 int TdbSortRecordsEx(int searchNumber, const char* sortSpecification, int mode);
9426
9427
9454 int TdbStartControl(char* name);
9455
9456
9489 int TdbUndeleteRecordPart(TdbHandle cursor);
9490
9491
9550 int TdbValidValues(int field_number, TdbHandle base_id, char* term);
9551
9573 int TdbGetFieldInfo(TdbHandle cursor, int* buf_len, char** rec_buf,
9574 int* hit_cnt, int** hit_vec, int* para_cnt);
9575
9584 int TdbPutFieldInfo(TdbHandle cursor, int buf_len, char* rec_buf);
9585
9586
9607 int TdbStartSummarization(void** handle, int engine_id);
9608
9624 int TdbAccumulateSummarization(void* handle, TdbHandle cursor);
9625
9643 int TdbGenerateSummary(void* handle, Char** summary);
9644
9658 int TdbEndSummarization(void* handle);
9659
9660
9661
9662
9663 // ------------------------------------------------------------------------
9664
9673
9674
9694 int TdbBaffitMode(void);
9695
9696
9728 int TdbCurrentDate(char* date, int* length);
9729
9730
9756 int TdbCurrentTime(char* timestr, int* length);
9757
9758
9803 int TdbFieldInfo(TdbHandle cursor, int mode, char* cvalue, int* ivalue);
9804
9805
9844 int TdbGetQueuedMessage(char* message, int* length, char* logfile);
9845
9846
9894 int TdbGetBatchJobResult(int* jobid, int* status, char* msg, size_t msg_size, size_t* msg_len, char* logfile, size_t logfile_size);
9895
9896
9925 int TdbLanguage(char* language);
9926
9927
9980 int TdbLicenseInfo(int mode, const char* strarg,
9981 char* stringValue, size_t strvalsz, int* intValue);
9982
9983
10041 int TdbSessionInfo(int mode, char* stringValue, int* intValue);
10042
10071 int TdbEnumViews(int64_t* enum_cursor, char* view_name, size_t name_size,
10072 char** view_def, size_t* def_size);
10073
10140 int TdbShellSymbol(char* symbol, int* symbol_length);
10141
10142
10181 int TdbUserInfo(int mode, char* stringValue, int* intValue);
10182
10183
10216 int TdbVersion(char* version, int* version_length);
10217
10218
10219 // ------------------------------------------------------------------------
10220
10227
10228
10266 int TdbAseRetCode(void);
10267
10268
10293 int TdbBreak(void);
10294
10295
10337 int TdbCallAse(void* aseID, char* argstr, int* arglen);
10338
10339
10377 int TdbExport(FilterData* fd);
10378
10379
10414 int TdbImport(FilterData* fd);
10415
10416
10446 int TdbLoadAse(char* ase_name, void** ase_id);
10447
10448
10486 int TdbLoadStatus(int mode);
10487
10488
10511 int TdbSaveStatus(void);
10512
10513
10559 int TdbSetBreakChars(int mask, void(*routine)(void), int mode);
10560
10561
10578
10579
10608 int TdbSetComforterInterval(int seconds, FP_fncomfortercb proc);
10609
10610
10647 int TdbStrNormalize(char* string, int* length, int mode);
10648
10649
10650 // ------------------------------------------------------------------------
10651
10659
10660
10710 int TdbGraphFind(int* resultSet, int sourceSet, int edgeSet, int targetSet,
10711 int exclusionSet, const char* condition);
10712
10713
10758 int TdbGraphResolve(int* resultSet, int mode, int edgeSet,
10759 const char* database);
10760
10761
10817 int TdbGraphTransitive(int* resultSet, int maxDepth, boolean reverse,
10818 boolean allEdges, int edgeSet, int sourceSet,
10819 int targetSet, const char* condition);
10820
10821
10878 int TdbGraphStartPathAnalysis(int** context, int algorithm, int maxDepth,
10879 int originSet, int edgeSet,
10880 int destinationSet, boolean reverse,
10881 const char* condition);
10882
10883
10933 int TdbGraphPathAnalysisStep(int* context);
10934
10935
10968 int TdbGraphClosePathAnalysis(int** context);
10969
10970
11004 int TdbGraphAnalysisSnapshot(int* context, int* count, int mode);
11005
11006
11043 int TdbGraphNextPath(int* context, char** database, int* recordId);
11044
11045
11086 int TdbGraphGetPath(int* context, char** edge, double* weight,
11087 char** database, int* recordId);
11088
11089
11147 int TdbGraphRecAssoc(TdbHandle* recordControl, const char* recordName,
11148 const char* edgeName, TdbHandle sourceRecord,
11149 TdbHandle targetRecord, double weight);
11150
11151
11211 int TdbGraphAddVertex(TdbHandle* recordControl, const char* recordName,
11212 const char* label, TdbHandle referenceRecord);
11213
11214
11215#ifndef DOXYGEN_SHOULD_SKIP_THIS
11232 int TdbGraphQuery(int* resultSet, int* setType, int* recordCount,
11233 const char* query);
11234#endif
11235
11236
11237 // ------------------------------------------------------------------------
11238
11247
11265 int TdbPutXmlBuffer(TdbHandle recordControl, boolean storeCopy,
11266 boolean validate, const char* xmldata, int length);
11267
11268
11284 int TdbPutJsonBuffer(TdbHandle recordControl, const char* jsondata, int length);
11285
11286
11303 int TdbPutXmlFile(TdbHandle recordControl, boolean storeCopy,
11304 boolean validate, const char* xmlfile);
11305
11306
11321 int TdbPutJsonFile(TdbHandle recordControl, const char* jsonfile);
11322
11323
11339 int TdbGetXmlBuffer(TdbHandle recordControl, char** xmldata, int* length);
11340
11341
11358 int TdbGetJsonBuffer(TdbHandle recordControl, char** jsondata, int* length);
11359
11360
11380 int TdbExecuteXPath(const char* xpath, int* searchSet);
11381
11382
11411 int TdbGetXmlFragments(int searchSetNo, const char* xpath,
11412 int startRis, int endRis, boolean highlight,
11413 void** buffer, int* length);
11414
11415
11416
11417 // ------------------------------------------------------------------------
11418
11423
11424
11439 int TdbDeallocate(void* buf);
11440
11441
11473 int TdbOpenBase(char* base);
11474
11475
11497 int TdbOpenBaseQuota(int* bases);
11498
11499
11523 int TdbExtractTextFromField(TdbHandle recordControl,
11524 int partNumber,
11525 const char* targetFieldName,
11526 const char* propertyNameField,
11527 const char* propertyValueField,
11528 const char* sourceFieldName,
11529 const char* fileName);
11530
11553 int TdbExtractTextFromFile(TdbHandle recordControl,
11554 int partNumber,
11555 const char* targetTextFieldName,
11556 const char* propertyNameField,
11557 const char* propertyValueField,
11558 const char* targetStringFieldName,
11559 const char* fileName);
11560
11585 int TdbExtractTextFromMem(TdbHandle recordControl,
11586 int partNumber,
11587 const char* targetFieldName,
11588 const char* propertyNameField,
11589 const char* propertyValueField,
11590 const char* targetStringFieldName,
11591 unsigned char* filedata,
11592 size_t fileDataSize,
11593 const char* fileName);
11594
11595
11596
11597 // ------------------------------------------------------------------------
11598
11608
11609
11689 TDB_DEPRECATED("Deprecated by TdbStartTrip")
11690 int TdbBeginTdbs(shell_dao_rec* shell_dao, boolean restart);
11691
11692
11730 TDB_DEPRECATED("Deprecated by TdbStopTrip")
11731 int TdbEndTdbs(boolean restart);
11732
11733
11781 TDB_DEPRECATED("Deprecated by TdbCopyBaseDesign")
11782 int TdbCopyBaseDef(char* old_base, char* new_base,
11783 base_spec_rec* base_specification);
11784
11816 TDB_DEPRECATED("Deprecated by TdbCopyThesDesign")
11817 int TdbCopyThesDef(const char* old_thes, const char* new_thes,
11818 base_spec_rec* thes_specification);
11819
11820
11914 TDB_DEPRECATED("Deprecated by TdbExecuteCcl")
11915 int TdbDaoOrder(int* order);
11916
11917
11957 TDB_DEPRECATED("Deprecated by TdbDeleteBaseField")
11959
11960
12006 int TdbGetBaseInfo(char* base, char* recordNameField, int* flags);
12007
12008
12050 TDB_DEPRECATED("Deprecated by TdbGetBaseDesign")
12051 int TdbGetBaseDef(char* base, base_spec_rec* baseSpecification);
12052
12053
12070 TDB_DEPRECATED("Deprecated without replacement")
12071 int TdbGetDefragStatus(const char* base, boolean* baf, boolean* bif,
12072 boolean* vif);
12073
12074
12075
12120 TDB_DEPRECATED("Deprecated by TdbGetBaseField")
12121 int TdbGetFieldName(field_spec_rec *field_specification, int ordinal);
12122
12159 TDB_DEPRECATED("Deprecated by TdbGetBaseField")
12161
12162
12201 TDB_DEPRECATED("Deprecated by TdbPutBaseDesign")
12203
12204
12270 TDB_DEPRECATED("Deprecated by TdbPutBaseField and TdbCloseBaseField")
12272
12273
12314 TDB_DEPRECATED("Deprecated by TdbGetThesDesign")
12315 int TdbGetThesDef(char* thesaurus, base_spec_rec* thesaurusSpec);
12316
12347 TDB_DEPRECATED("Deprecated by TdbPutBaseProperty")
12348 int TdbDefineXml(boolean xml);
12349
12350
12379 TDB_DEPRECATED("Deprecated by TdbPutBaseProperty")
12380 int TdbDefineGraph(base_spec_rec* base_spec, boolean enable);
12381
12382
12417 TDB_DEPRECATED("Deprecated by TdbPutThesDesign")
12418 int TdbPutThesDef(base_spec_rec* thesaurusSpec);
12419
12420
12460 TDB_DEPRECATED("Deprecated by TdbSearchInfo")
12461 int TdbGetSearch(int* search, int* record_count, int* hit_count);
12462
12463
12498 TDB_DEPRECATED("Deprecated by TdbSearchInfo")
12499 int TdbSearchResult(int* searchNumber, int* recordCount, int*hitCount,
12500 char** cclOrder, int* length);
12501
12502
12542 TDB_DEPRECATED("Deprecated by TdbGetClusterDesign")
12543 int TdbGetDbCluster(char* cluster, cluster_spec_rec* clusterSpecification);
12544
12545
12578 TDB_DEPRECATED("Deprecated by TdbPutClusterDesign")
12580
12581
12647 TDB_DEPRECATED("Deprecated by TdbSessionInfo and TdbUserInfo")
12648 int TdbGetSessionInfo(char* run_time, Char* logged_in,
12649 Char* FM, Char* UM, Char* SM);
12650
12651
12680 TDB_DEPRECATED("Deprecated by TdbGetNextProcLine")
12682
12683
12702 TDB_DEPRECATED("Deprecated by TdbExecuteCcl")
12704
12705
12747 TDB_DEPRECATED("Deprecated by TdbStartTrip and TdbShellModifyCcl")
12748 int TdbShellInit(int language);
12749
12750
12785 TDB_DEPRECATED("Deprecated by TdbExecuteCcl and TdbGetParsedCcl")
12787
12788
12789
12790#if defined(__cplusplus)
12791}
12792#endif
12793
12794#endif
12795
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 or permanent cluster.
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 TdbClusterInfo(int mode, const char *cluster, char *outstr, size_t outstrsz, int64_t *outint)
Retrieve information on a named database cluster.
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 TdbSubmitBatchJob(int *jobid, int jobtype, const char *base, const char *tform)
Submit a batch job to load data into a database or index a database, with job ID returned.
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 TdbSetComforterInterval(int seconds, FP_fncomfortercb proc)
Set the Comforter Interval.
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 TdbSetBreakChars(int mask, void(*routine)(void), int mode)
Set the Command Break Characters.
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 TdbEnumViews(int64_t *enum_cursor, char *view_name, size_t name_size, char **view_def, size_t *def_size)
Enumerate currently defined views.
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 TdbGetBatchJobResult(int *jobid, int *status, char *msg, size_t msg_size, size_t *msg_len, char *logfile, size_t logfile_size)
Retrieve a job status message from the TRIPdaemon message queue.
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 TdbRefreshTokenPair(const char *apikey, const char *current_refresh_token, char **access_token, int *access_token_length, char **refresh_token, int *refresh_token_length, time_t *access_expires_at, time_t *refresh_expires_at, char *username, size_t username_size)
Create an access/refresh token pair using a refresh token.
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 TdbPurgeTokens(int mode, time_t from_timestamp, time_t to_timestamp, int *purgedcount, FP_TdbPurgeTokensCallback callback, void *userdata)
Purge expired access/refresh token pairs.
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 TdbCreateTokenPair(const char *apikey, const char *user, const char *tag, char **access_token, int *access_token_length, char **refresh_token, int *refresh_token_length, time_t *access_expires_at, time_t *refresh_expires_at)
Create an access/refresh token pair for the specified or currently logged on user.
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 TdbEnumUserTokens(const char *username, void **handle, char *tag, size_t tag_size, time_t *created, time_t *access_expires_at, time_t *refresh_expires_at)
Enumerate access/refresh token pairs for a user.
int TdbApiLogSetVerbosity(int level)
Set verbosity level for the API log.
int TdbApiKeyInfo(const char *keyname, int mode, char *outstr, size_t outstrsz, int *outint)
Get information about a named API key.
int TdbShellModifyCcl(int language)
Modify the CCL locale language being used.
int TdbPurgeUserTokens(int mode, const char *username, time_t from_fimestamp, time_t to_timestamp, int *purgedcount, FP_TdbPurgeTokensCallback callback, void *userdata)
Purge expired access/refresh token pairs for a user.
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 TdbEnumApiKeys(void **handle, char *keyname, size_t keyname_size, char *comment, size_t comment_size, char *creator, size_t creator_size, char *credate, size_t credate_size, char *cretime, size_t cretime_size)
Enumerate available API keys.
int TdbChangeUser(const char *user, const char *password, int mode)
Change the currently logged on user, or temporarily logs out the current user.
int TdbCheckApiKey(const char *apikey)
Check if an API key is valid.
int TdbRevokeApiKey(const char *keyname)
Revoke an API key.
int TdbCreateApiKey(const char *keyname, const char *comment, boolean replace, char **keybuf, int *keybuf_size)
Create an API key for use with the token functions.
int TdbStopTrip(boolean restart)
Terminates a TRIP session started with TdbStartTrip.
int TdbRevokeTokens(const char *username, const char *token, const char *tag, int *revokecount, FP_TdbPurgeTokensCallback callback, void *userdata)
Revoke a specific token or all tokens for a particular user.
int TdbEnumTokens(void **handle, char *user, size_t user_size, char *tag, size_t tag_size, time_t *created, time_t *access_expires_at, time_t *refresh_expires_at)
Enumerate access/refresh token pairs for all users.
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:186
Database integrity rule specification.
Definition tripapi_types.h:301
Structure definition for a database.
Definition tripapi_types.h:85
Structure used for defining clusters of databases.
Definition tripapi_types.h:199
Definition of a field's design properties.
Definition tripapi_types.h:142
Shell/DAO interface record.
Definition tripapi_types.h:70
Definition of sentence / paragraph boundary markers.
Definition tripapi_types.h:124
Structure used for defining user properties.
Definition tripapi_types.h:210