Manual

Overview of the askSam 5 Database Engine. 1

About this Documentation.. 1

Characteristics of the askSam Database Engine. 1

Functionality of the askSam Engine. 2

System Requirements.. 2

Installing the askSam Database Engine. 2

To install the askSam Engine you download from the Internet: 2

To install the askSam Database Engine from CD-Rom... 3

Details about the Installation Process: 3

Configuring the Active Sever Page Example. 4

Using the askSam Engine. 5

Creating files for use with the askSam Engine. 5

Documents and Outputting Documents. 5

Document Handles. 5

Using the askSam Engine in a Visual Basic program... 8

Defining an object with the CreateObject command.. 8

Accessing the askSam Engine using OLE Automation.. 8

Visual Basic Sample Application.. 9

ASKSAM.BAS. 9

Using the askSam Engine in Active Server Programming.. 11

Accessing the askSam Engine via Active Server Pages. 11

Active Server Page Sample Application.. 11

ASKSAM.ASP. 12

Search and Sort Commands.. 14

Boolean Searches. 15

Wildcard Searches. 16

Searching for Phrases. 18

Fuzzy Searching.. 19

Searching in a Specific Field.. 20

Numeric Searching.. 23

Proximity Searching.. 25

Date Searching.. 28

Case Sensitive Searches. 33

Index Searches. 35

Sorting.. 35

Component Application Programming Interfaces (APIs) 39

File Functions. 39

OpenAsFile Function. 39

OpenAsFileEx Function. 43

CloseAsFile Function. 47

IsFileOpened Function. 50

DeleteAsFile Function. 53

CopyASFile Function. 56

CopyASFileSettings Function. 59

GetAsFileSize Function ^. 62

GetAsFileCreationDateTime Function. 65

GetAsFileModifiedDateTime Function. 68

GetAsFileName Function. 71

GetFileAccessGroupNames Function ^. 73

GetAccessGroupNames Function ^. 76

GetFirstAccessGroup Function ^. 78

GetNextAccessGroup Function ^. 81

GetAccessGroupReadOnly Function ^ vb – asp - comments. 84

GetAccessGroupBits1 Function ^ vb – asp - comments. 87

GetAccessGroupBits2 Function ^ vb – asp - comments. 90

AddAccessGroup Function ^. 93

CopyAccessGroup Function ^. 96

DelAccessGroup Function ^. 99

RenameAccessGroup Function. 102

AuthenticateAccessGroup Function. 105

SetAccessGroup Function ^ vb – asp - comments. 108

GetCurrentFileAccess Function ^ vb – asp - comments. 110

EncryptFile Function. 112

DecryptFile Function. 114

IsFileEncrypted Function. 117

ImportASW3File Function. 120

ImportASW3FileEx Function ^. 123

GetASW3ImportStatus Function ^ vb – asp - comments. 126

ImportASW3Cancel Function ^ vb – asp - comments. 128

IndexFile Function ^. 130

GetIndexStatus Function ^ vb – asp - comments. 132

GetIndexStatistics Function ^ vb – asp - comments. 134

IndexCancel Function ^. 136

IsFileIndexed Function. 139

DeleteIndex Function. 142

PackFile Function. 145

GetPackStatus Function ^ vb – asp - comments. 148

GetPackStatistics Function ^ vb – asp - comments. 151

CancelPack Function ^ vb – asp - comments. 153

DoesFileNeedPacking Function ^. 155

GetSizeFragmentedSpace Function vb. 157

GetPackStatusAfter Function ^ asp – vb. 160

LockDoc Function. 163

UnLockDoc Function. 167

IsDocLock Function. 171

FirstDoc Function. 175

LastDoc Function. 178

NextDoc Function. 181

PrevDoc Function. 184

GetFileNoRecords Function. 187

GetFileNoDocs Function. 190

DeleteDoc Function. 193

UnDeleteDoc Function. 197

IsDocDeleted Function. 201

FirstDelDoc Function. 204

LastDelDoc Function. 207

NextDelDoc Function. 210

PrevDelDoc Function. 213

FirstDocWithName Function. 216

NextDocWithName Function. 219

GetDocName Function. 222

GetDocSerialNum Function. 225

GotoDocSerialNum Function. 228

GetDocNumber Function. 231

GoToDocNumber Function. 234

GoToDocName Function. 237

GetMatchContext Function ^ vb – asp - comments. 240

GetMatchHits Function ^vb. 243

SearchGetMaxHits Function ^ vb. 246

GetFieldDataEx Function vb. 249

SetMatchData Function ^ vb. 252

GetOutput Function ^^ VB - ASP.. 255

GetVersion Function. 258

SetFieldData Function ^ asp - vb. 260

FindFieldNames Function. 263

GetNextEntryFormCounter Function. 266

GetEntryFormCounter Function. 269

SetEntryFormCounter Function. 272

GetMinimumNewRecSize Function. 275

SetMinimumNewRecSize Function ^ vb - asp. 278

GetIndexMemSize Function ^ vb - asp. 281

SetIndexMemSize Function. 284

LoadGraphic Function ^ vb – asp. 287

SaveDelimitedDoc Function vb – asp - comments. 290

SaveDelimitedDocAppendEntryForm Function vb – asp - comments. 293

RunReport Function vb – asp - comments. 296

GetCryptStatus Function vb – asp - comments. 299

CancelCrypt Function vb – asp - comments. 302

GetASFilePackedDateTime Function. 305

GetDocAuthor Function. 308

GetDocKeywords Function. 311

GetDocBulk Function vb – asp - comments. 314

GetDocPackage Function vb – asp - comments. 317

GetEntryFormShortcutKey Function. 320

CopyDocToFile Function vb – asp - comments. 323

CopyDocument Function vb – asp - comments. 326

CopyEntryFormToDocument Function vb – asp - comments. 329

ASFindReplaceText Function vb – asp - comments. 332

LoadMultipleDocs vb – asp - comments. 335

EndLoadMultipleDocs vb – asp - comments. 338

GetASDocSize. 341

ConvertTwoDigitYears Function. 344

GetBookmarkPos Function. 347

FirstBookmark Function vb – asp - comments. 350

NextBookmark Function vb – asp - comments. 353

DelBookmark Function. 356

DelBookmarkPos Function. 359

RenameBookmark Function. 362

PickListSaveField Function vb – asp - comments. 365

PickListLoadField Function vb – asp - comments. 368

PickListGetFirstField Function vb – asp - comments. 371

PickListGetNextField Function vb – asp - comments. 374

PickListDeleteField Function vb – asp - comments. 377

GetFileIdent Function. 380

GetFileVersion Function ^. 383

GetFileLightMatch Function ^. 386

SetFileLightMatch Function ^. 389

GetFileEntryMode Function ^. 392

SetFileEntryMode Function ^. 395

GetFileFieldChar Function. 398

SetFileFieldChar Function ^. 401

GetNewDocLocation Function ^. 404

SetNewDocLocation Function ^ vb – asp - comments. 407

GetShowRuler Function. 410

SetShowRuler Function. 413

GetShowResults Function. 416

SetShowResults Function. 419

GetShowResults Function. 422

SetResultsViewSize Function. 425

GetNearSetting Function ^ VB – ASP - comments. 428

SetNearSetting Function. 431

GetSortArticles. 434

SetSortArticles Function. 437

GetDefaultEntryForm.. 440

SetDefaultEntryForm Function. 443

GetDisplayBookmarkIcon. 446

SetDefaultEntryForm Function. 449

GetHideFieldCharacters. 452

SetHideFieldCharacters Function. 455

GetPromptForDocProperties. 458

SetPromptForDocProperties Function. 461

GetReportOuputSeparator ^ asp –vb - comments. 464

SetReportOuputSeparator Function –VB – asp - comments. 467

GetDateTimeWeekFormat ^ asp –vb - comments. 470

SetDateTimeWeekFormat Function –VB – asp - comments. 473

GetInterpretDateFormat Function. 477

SetInterpretDateFormat Function. 480

GetBeepOnError Function. 483

SetBeepOnError Function. 486

GetASCurrencyFormat Function ^ vb – asp - comments. 489

SetASCurrencyFormat Function. 492

GetFileSubject Function. 496

SetFileSubject Function. 499

GetFileAuthor Function. 502

SetFileAuthor Function. 505

GetFileKeywords Function. 508

SetFileKeywords Function. 511

GetFileComments Function. 514

SetFileComments Function. 517

GetLastModifiedBy Function. 520

SetLastModifiedBy Function. 523

GetFileTextForeBackgroundColor Function ^ vb – asp - comments. 526

SetFileTextForeBackgroundColor Function ^ vb – asp - comments. 529

GetFilePrintSettings Function. 532

SetFilePrintSettings Function. 535

GetFileZoom Function. 539

SetFileZoom Function. 542

GetFilePackBaktoSav Function. 545

SetFilePackBaktoSav Function. 548

GetFileSortOrder Function. 551

SetFileSortOrder Function. 554

GetNoiseWords Function ^. 557

SetNoiseWords Function. 560

GetPunctuationChars Function. 563

SetPunctuationChars Function. 566

GetIndexSingleChars Function. 569

SetIndexSingleChars Function. 572

GetIndexFieldNames Function. 575

SetIndexFieldNames Function. 578

GetIndexDateNumFieldNames Function. 581

SetIndexDateNumFieldNames Function. 584

DeleteIndexDateNumFieldNames Function. 587

LoadFilePunctuation Function. 590

GetHighlightedMatchContext Function. 593

GetCountOutput Function ^ vb – asp - comments. 596