This Documentation is intended to provide a description of the programming interfaces available in the askSam Database Engine. The Documentation assumes you are familiar with the programming techniques and syntax of Visual Basic or Active Server pages. For more information on Visual Basic or Active Server page programming, there are a variety of third party publications available.

To change the shading of the Icon 1 Style, choose Borders and Shading from the Format menu. Select a new shade or color, and choose OK to accept your choice.

Characteristics of the askSam Database Engine

The askSam Engine was designed to be fast and flexible.

§ Fast - The askSam Engine provides some of the fastest and most powerful searches you'll find in any product.

§ Flexible - The askSam database was specifically designed to deal with free-form data. Unlike traditional database which require structured data. askSam can deal with both structured and unstructured information.

With the askSam Engine, your application has access to askSam's powerful search capabilities including full text searches, date, numeric, proximity, and Boolean searches, as well as fuzzy, wildcard and more. The askSam Engine will also allow you to perform many types of tasks including outputting reports, sorting information, and storing data in an easily retrievable format.

Functionality of the askSam Engine

The askSam Engine was designed to give you access to the askSam's database and search functions. The Engine exposes functions which control:

§ how an askSam file is searched

§ how search results are displayed

§ how data from a retrieved document is displayed

The askSam Engine is designed to run on 32 bit Windows operating systems. It requires a minimal amount of resources (disk space and memory).

To run the askSam Engine you must have:

§ A computer running a Microsoft Windows 32 bit operating system (Windows 95, 98, ME, NT, 2000, or XP)

§ 15 MB of free disk space

NOTE: In order to do Active Server page programming, you will need to be running a Web server that supports Active Server pages. We've run all of our ASP code using Microsoft Internet Information Server.

Installing the askSam Database Engine

You can either download the askSam Database Engine from the Internet, or you can receive the Database Engine on diskette. Maintenance releases and updates will be available on a regular basis from our Internet site: http://www.askSam.com/update/.

To install the askSam Engine you download from the Internet:

1. Place the EXE file you download into a temporary directory.

2. Run the EXE.

3. Follow the instructions on your screen.

4. When the Setup is complete, delete the temporary directory and the downloaded EXE.

To install the askSam Database Engine from CD-Rom

1. Insert the askSam Database Engine CD-Rom in your CD-Rom drive.

2. The installation program should start automatically.

3. Follow the instructions on your screen.

Details about the Installation Process:

During the installation you will be asked for the location of the where to install the SDK. The default install location is C:\Program Files\askSam\askSam5\SDK. You can also enter a different path if you would like to change the default install path.

The Setup program automatically:

1. Adds ‘askSam 5 SDK' to the Start | Programs menu.

2. Copies the following files to the selected directory

GEAR81SD.DLL

AS_Eng5.DLL

ASENG5.TLB

ASENG5.OCX

SDKDocs5.ASK

AS_CRYPT.EXE

AS_CVT.EXE

AS_IDX.EXE

AS_PACK.EXE

REGSVR32.EXE

Examples\

Help\

1. Copies a sample Visual Basic program into a subdirectory named 'Examples\VB'

2. Copies a sample Active Sever Page Program into a subdirectory named Examples\asp'

3. Copies a sample C/C++ Program into a subdirectory named Examples\C\Demo'

4. Copies the C/C++ Header file and Lib file for Microsoft Visual C/C++ 6 SP3 into a subdirectory named Examples\C'

5. Registers the askSam Database Engine for Visual Basic or Active Server Pages.

Notes

1: The VB Sample application displays the README.ASK file. It is a simple application which uses the askSam Engine to display, search, and browse through an askSam file.

2: The ASENG5.BAS file contains all the pre-defined values you'll need to access the askSam Engine from a BASIC program. You can insert this file into any Visual Basic program. This file is saved in the VBsample subdirectory.

3: The ASKSAM.ASP file (in ASKASP subdirectory) contains all the pre-defined values you'll need to access the askSam Engine from an ASP program. It also contains some pre-defined functions which you can use in your ASP programs. You will want to add this file to any ASP program that uses the askSam Engine.

Configuring the Active Sever Page Example

1. Create a directory for your askSam ASP code under the directory where Microsoft Internet Information Server (IIS) is installed. By default, IIS is installed in the InetPub directory. In these configuration instructions will assume you name the askSam ASP directory ASKASP.

2. When you install the askSam Engine, we install sample ASP code in an ASKASP directory under the askSam Engine. You will want the contents of ASKASP subdirectory which we install into the ASKASP directory you created in step #1.

3. Create a Virtual Directory for the Active Server Page sample program.

a) Start the Microsoft Internet Service Manager

b) Double Click on the WWW Service

c) Under the WWW Service Properties select Directories -> Add

d) Enter the directory where you copied the askSam ASP sample code. If you've used the directory names we've described, the directory is C:\InetPub\ASKASP

e) Name the Virtual Directory ASKASP

f) Mark Read and Execute under Access

g) Select OK

h) Exit the Microsoft Internet Service Manager

4. To access the ASP sample, use the URL - http://<Domain>/ASKASP. Where Domain is your Domain name. This will display the Default.htm file and give you access to the ASP sample.

Using the askSam Engine

Creating files for use with the askSam Engine

Use askSam 5 to create and index the askSam files you will access with the askSam Engine. If you are testing the SDK, you can download a trial version of askSam 5 from our Web site (http://www.asksam.com/trial/asksam.asp), or contact our sales department for an evaluation copy (sales@askSam.com).

Documents and Outputting Documents

Like all databases, the data stored in an askSam database is divided into records. Since askSam does not have strict size limits or predefined structure for these records, we refer to them as "Documents".

The Documents stored in askSam can contain formatting information (such as fonts, colors, tabs, indents, etc.). When you access the data, you can have the askSam Engine return this data in one of three formats:

1. TEXT - removes all formatting and outputs ASCII text.

2. RTF - Microsoft's Rich Text Format retains all the formatting included in the original askSam Document (such as fonts, colors, tabs, indents, etc.).

3. HTML - HTML retains the basic formatting which displays in a Web browser (font sizes, colors, bold and italic).

Document Handles

When you add a Document to an askSam file, askSam assigns a unique Document Handle to the Document. The Document Handle is how the askSam Engine accesses data stored in an askSam database.

For example, a search request passed to the askSam engine will return Document Handles from the Documents which match the request. Using these Document Handles, you can retrieve specific fields from the selected Documents, or you can retrieve the entire Document.

Note

The unique Document Handle generated for each Document is based upon the position (or address) of the Document in the database. Document Handles remain constant until a file is packed (a process which compresses and optimizes the database). During this process, askSam checks and removes any documents that have been marked for deletion. Packing generates a new set of Document Handles for the file. To Pack a file you use the FILE - PACK command in askSam for Windows.

If you need a reference to the document that doesn’t change after packing the database, you should use a document serial number. You can get a document serial number from a document handle by calling the GetDocSerialNum function.

Accessing the Document Handle.

The askSam Engine offers several ways to retrieve Document Handles. One way is to open a file, access the first document, and read the Document Handle from this Document. You can use functions provided by the askSam Engine to walk through the database and sequentially access each Document and read its Document Handle.

The following section of code retrieves the first document within the current open file:.

Example:

1: Set asksam = Form1.ASEng1

2: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

4: If asksam.IsFileOpened Then

6: Doc_Id = asksam.FirstDoc(DT_DATA)

7: RText1.TextRTF = asksam.LoadDoc(DT_DATA, FF_RTF, Doc_Id)

9: End If

The following section of code retrieves the next document within the current open file.

Example:

1: Set asksam = Form1.ASEng1

2: Cur_Id = Doc_Id

3: Doc_Id = asksam.NextDoc(Cur_Id, DT_DATA)

4: RText1.TextRTF = asksam.LoadDoc(DT_DATA, FF_RTF, Doc_Id)

You can also access Document Handles from a search request. Pass the askSam Engine a search request. The Engine returns the Document Handles from the selected Documents.

Example:

1: Set asksam = Form1.ASEng1

3: Prev_Doc = 0

4: Doc_Id = asksam.SearchFile(SearchString, Prev_Doc)

6: If Doc_Id > 0 Then

8: RText1.TextRTF = asksam.LoadDoc(DT_DATA, FF_RTF, Doc_Id)

10: End If

Using the askSam Engine in a Visual Basic program

From your Visual Basic programs, you access the askSam Database Engine as an OCX (or ActiveX) Control. The askSam Engine can be accessed by two methods. These are described below:

Defining an object with the CreateObject command

The askSam Database Engine is registered with the name “ASKSAM.EngineCtrl.5” In your Visual Basic program, you can create an "asksam" object, and use this object to access the askSam database functions in your program.

Example:

Set asksam = CreateObject(“ASKSAM.EngineCtrl.5”)

asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

The first line creates the asksam object. This object gives you access to the commands in the askSam Database Engine. The second line uses the OpenASFile function in the askSam Database Engine. This function opens an askSam file. A description of all askSam Engine functions is included later in this documentation.

Note

For more information on the CreateObject command, see the Visual Basic Manual.

Accessing the askSam Engine using OLE Automation

OLE Automation is the simplest way to access the askSam Database Engine from a Visual Basic program. First, add the askSam Engine to the OLE Tool Bar in Visual Basic. Then, place the askSam Engine in your VB Form (just as you would insert any other OLE object).

To add the askSam Database Engine to the OLE Toolbar:

a) Choose TOOLS -> CUSTOM CONTROLS

b) Select the “ASEng OLE Control Module”. The askSam Database Engine OLE Control will appear on the OLE Tool Bar.

Note

For more information using OLE Automation in Visual Basic programs, see your Visual Basic Manual.

Visual Basic Sample Application

We've included a VB sample application with the askSam Engine. The README.EXE in the Examples\VB directory is a Visual Basic program that uses the askSam Engine to display information in the QOL.ASK file.

This sample application demonstrates the following functions:

§ Opening an askSam file using the OpenASFile function

§ Closing an askSam file using the CloseASFile function

§ Searching an askSam file using the SearchFile function

§ Returning data from an askSam Documents as RTF data

§ Returning data from a specific field in and askSam Document using the GetFieldData function

§ Using the FirstDoc, NextDoc, PrevDoc, LastDoc, DeleteDoc, IsFileOpened functions

This sample application and the sample code in the documentation were created using Visual Basic 6.0 Service Pack 3.

ASKSAM.BAS

The ASKSAM.BAS file (in Examples\VB subdirectory) was designed to simplify using the askSam Engine in Visual Basic programs. It contains definitions for the askSam API functions you can use in your programming.

You will want to add this file to a VB program that uses the askSam Engine.

The ASKSAM.BAS file contains several sections:

§ Document Types

§ Format Types

§ Saving Documents

§ Opening Documents

§ Loading Documents

Each section assigns a value to a variable name.

For example:

' Format Filter Types used when loading documents

Public Const FF_TEXT = &H1&

Public Const FF_HTML = &H2&

Public Const FF_RTF = &H4&

When using an askSam API functions, you would use the variable name rather than the value.

For example:

Text = asksam.LoadDoc(DT_DATA, FF_TEXT, Doc_Id)

You can view the ASKSAM.BAS using any text editor.

Using the askSam Engine in Active Server Programming

Active Server programming is a powerful way to access data on a Web server. In Active Server programming, you use a Visual Basic scripting language to manipulate and format data. Your scripts can access OCX Controls (ActiveX Controls). This adds a lot of functionality to the applications you can create using Active Server programming.

The askSam Engine is an OCX Control which you can access from the Active Server pages you create. Using Active Server pages, you can let people search, browse, and output reports from askSam databases.

Active Server programming offers a powerful way for people to create solutions on a Web-based platform. The ASP code is fairly standard VB scripting combined with HTML. The best part... because your application is executed on the Web server, it's platform independent. Anyone with a standard browser (Netscape Navigator, Microsoft Internet Explorer, etc) can run your application. It doesn't matter whether they are running a Windows PC, a Macintosh Computer, a Unix Workstation, or any other operating system.

Accessing the askSam Engine via Active Server Pages

To access the askSam Engine, define it as an object using the CreateObject command. The askSam Engine is registered under the name “ASKSAM.EngineCtrl.5”.

Example:

Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

The first line creates the asksam object. This object gives you access to the commands in the askSam Database Engine. The second line uses the OpenASFile function in the askSam Database Engine. This function opens an askSam file. A description of all askSam Engine functions is included later in this documentation.

Active Server Page Sample Application

We've included a Active Server Pages (ASP) sample application with the askSam Engine. The ‘Examples\ASP\Bulletin’ directory contains code for an ASP Bulletin application. The ‘Examples\ASP\WebPub’ directory contains code for an ASP application that simulates a lots of our Web Publisher product functionality.

This sample applications demonstrate the following functions:

§ Opening an askSam file

§ Closing an askSam file

§ Searching an askSam file

§ Returning askSam Documents as HTML data

§ Using the NextDoc and PrevDoc functions

§ Outputting fields from askSam Documents into an HTML table

§ Defining links from a table back to an askSam Document

ASKSAM.ASP

The ASKSAM.ASP file (in Examples\ASP subdirectory) contains all the pre-defined values you'll need to access the askSam Engine from an ASP program. It also contains some pre-defined functions which you can use in your ASP programs.

You will want to add this file to any ASP page that uses the askSam Engine.

The ASKSAM.ASP file contains several sections:

§ Document Types

§ Format Types

§ Saving Documents

§ Opening Documents

§ Loading Documents

Each section assigns a value to a variable name. For example:

' Format Filter Types used when loading documents and data from fields

FF_TEXT = 1

FF_HTML = 2

FF_RTF = 4

When using an askSam API functions, you would use the variable name rather than the value. For example:

Text = asksam.LoadDoc(DT_DATA, FF_TEXT, Doc_Id)

You can view the ASKSAM.ASP using any text editor.

The sample applications and the sample code in the documentation were created and tested using Visual Basic Script on Microsoft Internet Information Server.

Search and Sort Commands

askSam offers a variety of powerful searches. You pass a search request to the askSam Engine using the SearchFile() function. Below are links to the askSam search commands:

§ Boolean Searches Use Boolean operators AND, OR, and NOT to combine elements in a search.

§ Wildcard Searches Wildcard searches let you find information without an exact match. askSam lets you use * and ? in your searches.

§ Searching For Phrases Search for multiple words as a single phrase.

§ Fuzzy Searching Helps locate information when you're not sure of the spelling.

§ Searching in a Field Restricts a search to the contents of a specific field.

§ Numeric Searches Searches based on numeric comparison (>, <, =, >=, <=, <>)

§ Proximity Searches Locates two words or phrases occurring within a specified proximity of one another.

§ Date Searches Searches based on date.

§ Case Sensitive Searches Determines whether searches are case sensitive.

§ Indexed Searches Uses the index to search a database. Increases search speed.

§ Sorting Outputs documents in sorted order.

Boolean Searches

askSam allows the use of the Boolean operators AND, OR, and NOT to combine the elements in your search.

Usage:

Enter: golf and tennis and beach

Find: documents containing the words golf, tennis, and beach

Enter: golf tennis beach

Find: documents containing the words golf, tennis, and beach

This search is identical to the first search.

Enter: Florida or Hawaii or California

Find: documents containing either Florida, Hawaii, or California

Enter: not expensive and not crowded

Find: documents which do not contain the words expensive and crowded

Enter: red and (white or blue)

Find: documents containing red and either white or blue.

Enter: (red and white) or blue

Find: documents containing red and white or documents containing blue.

Sample Code:

11: <%@ Language=VBScript %>

12:

13:

14:

15: <%

16: File_Path = Server.MapPath("./")

17: File_Name = File_Path + "\bulletin.ask"

18:

19: Set asksam = Server.CreateObject("ASKSAM.EngineCtrl.5")

20: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

21:

22: If asksam.IsFileOpened Then

23:

24: Doc_Id = asksam.SearchFile("Tennis Florida {or} California", 0)

25: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

26: Response.Write UserRecord

27: asksam.CloseASFile

28:

29: End If

30: %>

The previous sample could have been written like this:

31: <%@ Language=VBScript %>

32:

33:

34:

35: <%

36: File_Path = Server.MapPath("./")

37: File_Name = File_Path + "\bulletin.ask"

38: Set asksam = Server.CreateObject("ASKSAM.EngineCtrl.5")

39: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

40:

41: If asksam.IsFileOpened Then

42:

43: SearchRequest = "Tennis Florida {or} California"

44: Doc_Id = asksam.SearchFile(SearchRequest, 0)

45: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

46: Response.Write UserRecord

47: asksam.CloseASFile

48:

49: End If

50: %>

Wildcard Searches

Wildcard searches let you find information without an exact match. Searches can include the wildcard symbols * and ?. The * replaces multiple characters (up to 80). The ? replaces a single character.

Usage:

Enter: German*

Find: Germany, Germanic, Germans, ...

Enter: *CAD

Find: AutoCAD, NiCad, ...

Enter: 80?86

Find: 80286, 80386, 80486, ...

Sample Code:

51: <%@ Language=VBScript %>

52:

53:

54:

55: <%

56: File_Path = Server.MapPath("./")

57: File_Name = File_Path + "\bulletin.ask"

58: Set asksam = Server.CreateObject("ASKSAM.EngineCtrl.5")

59: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

60:

61: If asksam.IsFileOpened Then

62:

63: Doc_Id = asksam.SearchFile("German*", 0)

64: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

65: Response.Write UserRecord

66: asksam.CloseASFile

67:

68: End If

69: %>

The previous sample could have been written like this:

70: <%@ Language=VBScript %>

71:

72:

73:

74: <%

75: File_Path = Server.MapPath("./")

76: File_Name = File_Path + "\bulletin.ask"

77: Set asksam = Server.CreateObject("ASKSAM.EngineCtrl.5")

78: Search = Request.Form("SearchTerm")

79: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

80:

81: If asksam.IsFileOpened Then

82:

83: SearchRequest = Search & "*"

84: Doc_Id = asksam.SearchFile(SearchRequest, 0)

85: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

86: Response.Write UserRecord

87: asksam.CloseASFile

88:

89: End If

90: %>

Comments on the Sample Code:

In the line:

Search = Request.Form("SearchTerm")

The data posted from your search form (referred to as "SearchTerm") is assigned to the variable "Search".

We then add the wildcard to the end of the search request in the line:

SearchRequest = Search & "*"

Searching for Phrases

To Search for a phrase, the phrase must be enclosed in square brackets [ ]. Entering multiple words that are not enclosed in square brackets results in a Search for Documents containing all the requested words but the words do not have to appear together as a phrase.

Usage:

Enter: World Bank

Find: In today's world, the bank is an important institution.

To find words directly next to each other, place square brackets [ ] around the phrase.

Enter: [World Bank]

Find: Last year the World Bank lent record amounts to developing countries.

Sample Code:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

11:

12: If asksam.IsFileOpened Then

13:

14: Doc_Id = asksam.SearchFile("[World Bank]", 0)

15: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

16: Response.Write UserRecord

17:

18: asksam.CloseASFile

19:

20: End If

21: %>

The previous sample could have been written like this:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: Search = Request.Form("SearchTerm")

11: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

12:

13: If asksam.IsFileOpened Then

14:

15: SearchRequest = "[" & Search & "]"

16: Doc_Id = asksam.SearchFile(SearchRequest, 0)

17: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

18: Response.Write UserRecord

19:

20: asksam.CloseASFile

21:

22: End If

23: %>

Comments on the Sample Code:

In the line:

Search = Request.Form("SearchTerm")

The data posted from your search form (referred to as "SearchTerm") is assigned to the variable "Search".

We then turn the search request into a Phrase Search by placing brackets around Search in the line:

SearchRequest = "[" & Search & "]"

Fuzzy Searching

A fuzzy search helps you locate information when you're not sure of the spelling

Usage:

Enter: {fuzzy} Kathy

Find: Documents containing either Kathy, Kathi, Cathy, etc.

Sample Code:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

11:

12: If asksam.IsFileOpened Then

13:

14: Doc_Id = asksam.SearchFile("{FUZZY} Kathy", 0)

15: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

16: Response.Write UserRecord

17:

18: asksam.CloseASFile

19:

20: End If

21: %>

The previous sample could have been written like this:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: Search = Request.Form("SearchTerm")

11: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

12:

13: If asksam.IsFileOpened Then

14:

15: SearchRequest = "{Fuzzy}" & Search

16: Doc_Id = asksam.SearchFile(SearchRequest, 0)

17: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

18: Response.Write UserRecord

19:

20: asksam.CloseASFile

21:

22: End If

23: %>

Comments on the Sample Code:

In the line:

Search = Request.Form("SearchTerm")

The data posted from your search form (referred to as "SearchTerm") is assigned to the variable "Search".

Searching in a Specific Field

Restricts an askSam search to a specific field.

Usage:

Syntax: word {IN} Fieldname

Enter: White {IN} Name:

Find: documents where White appears in the Name: field.

Enter: [Windows NT] {IN} OS:

Find: documents where the phrase Windows NT appears in the OS: field.

If the field you are searching is longer than a single line, use the long command to search the entire field.

Enter: askSam {IN LONG} Notes:

Find: documents where askSam appears anywhere in the Notes: field. The Notes field can be multiple lines.

Comments:

Use the LONG command with the IN command when you wish to search fields which are longer than one line. In askSam, a field can contain up to 16,000 lines of information. When using the LONG command, askSam assumes the multi-line field ends with a closing bracket "]". The LONG command lets you use a parameter to define how the field ends.

Enter: askSam {IN LONG :B } Notes:

Find: documents where askSam appears anywhere in the Notes: field. The Notes field ends when a Blank line is encountered.

If, instead of {IN LONG :B}, you place another character after the colon ( : ), that character will define the end of the field. For example:

Enter: askSam {IN LONG :/ } Notes:

Find: documents where askSam appears anywhere in the Notes: field. The Notes field ends when a slash / is encountered.

Sample Code:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

11:

12: If asksam.IsFileOpened Then

13:

14: Doc_Id = asksam.SearchFile("White {IN} Name:", 0)

15: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

16: Response.Write UserRecord

17:

18: asksam.CloseASFile

19:

20: End If

21: %>

The previous sample could have been written like this:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: Search = Request.Form("SearchTerm")

11: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

12:

13: If asksam.IsFileOpened Then

14:

15: SearchRequest = Search & "{IN LONG} Notes: "

16: Doc_Id = asksam.SearchFile(SearchRequest, 0)

17: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

18: Response.Write UserRecord

19:

20: asksam.CloseASFile

21:

22: End If

23: %>

Comments on the Sample Code:

In the line:

Search = Request.Form("SearchTerm")

The data posted from your search form (referred to as "SearchTerm") is assigned to the variable "Search".

We then turn the search request into a Field Search by adding the command

"{in long} Notes: " to Search in the line:

SearchRequest = Search & "{IN LONG} Notes: "

Numeric Searching

A numeric search selects documents based on a numeric comparison (>, <, =, >=, <=, <>).

Usage:

Enter: Price: < 2,000

Find: documents where the number in the Price: field is less than 2000.

Comments:

You can use the following relational operators in numeric searches:

< less than

<= less than or equal to

= equal to

>= greater than or equal to

> greater than

<> not equal to

Sample Code:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

11:

12: If asksam.IsFileOpened Then

13:

14: Doc_Id = asksam.SearchFile("Price: < 2,000", 0)

15: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

16: Response.Write UserRecord

17:

18: asksam.CloseASFile

19:

20: End If

21: %>

The previous sample could have been written like this:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: Search = Request.Form("SearchTerm")

11: SearchComparison = Request.Form{"Comparison"}

12: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

13:

14: If asksam.IsFileOpened Then

15:

16: SearchRequest = "Price: " & SearchComparison & " " & Search

17: Doc_Id = asksam.SearchFile(SearchRequest, 0)

18: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

19: Response.Write UserRecord

20:

21: asksam.CloseASFile

22:

23: End If

24: %>

Comments on the Sample Code:

In the line:

Search = Request.Form("SearchTerm")

The data posted from the search form (referred to as "SearchTerm") is assigned to the variable "Search".

In the line:

SearchComparison = Request.Form("Comparison"),

The data posted from the search form (referred to as "Comparison") is assigned to the variable "SearchComparison".

We then turn the search request into a Numeric Search using Search and SearchComparison in the line:

SearchRequest = "Price: " & SearchComparison & " " & Search

Proximity Searching

A Proximity Search locates two words or phrases occurring within a specified proximity of one another. This enables you to use the natural elements contained within blocks of normal text (Words, Lines, Sentences and Paragraphs) to tailor your search.

Usage:

Syntax: word1 {VICINITY :Parameter word2} or word1 {VIC :Parameter word2}

Enter: [Margaret Thatcher] {VICINITY :0P [Ronald Reagan]}

Find: documents where Margaret Thatcher and Ronald Reagan appear in the same paragraph.

Enter: Internet {VICINITY :1WB access}

Find: documents where Internet appears 1 word before access.

Enter: veto {VICINITY :2LA [President Clinton]}

Find: documents where veto appears within 2 lines after President Clinton.

Enter: GM {VICINITY :1SE Ford}

Find: documents where GM appears 1 sentence either side of Ford.

Enter: askSam {VICINITY :FL}

Find: documents where askSam appears in the first line.

Parameters:

W - Words

L - Lines

S - Sentences

P - Paragraphs

B - Before

A - After

E - On either side of

0 (Zero) - In the same Word, Line, Sentence, or Paragraph

FW - First Word

FL - First Line

FS - First Sentence

FP - First Paragraph

FX - First character x encountered, except W, S, P, L

Comments:

If you use any form of the First parameter (First Word, First Line, First Sentence, First Paragraph, or First character), do not specify Word2. Otherwise specify Word2 after the parameter.

Most VICINITY requests need three parameters:

a) The unit size (word, sentence, paragraph, etc.)

b) The number of units to look within (0, 1, 2, 3, etc.)

c) The direction to look (before or after).

You can mix these modifiers to create a variety of searches. Examples are above in the Usage section.

Sample Code:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

11:

12: If asksam.IsFileOpened Then

13:

14: Doc_Id = asksam.SearchFile("veto {VIC :2LA President}", 0)

15: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

16: Response.Write UserRecord

17:

18: asksam.CloseASFile

19:

20: End If

21: %>

The previous sample could have been written like this:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: FirstWord = Request.Form("FirstSearchTerm")

11: SecondWord = Request.Form("SecondSearchTerm")

12: SearchStructure = Request.Form("Structure")

13: SearchDirection = Request.Form("Direction")

14: SearchRange = Request.Form("Range")

15: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

16:

17: If asksam.IsFileOpened Then

18:

19: SearchRequest = FirstWord & " {VIC :" & SearchRange

20: SearchRequest = SearchRequest & SearchStructure & SearchDirection

21: SearchRequest = SearchRequest & " " & SecondWord & "}"

22: Doc_Id = asksam.SearchFile(SearchRequest, 0)

23: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

24: Response.Write UserRecord

25:

26: asksam.CloseASFile

27:

28: End If

29: %>

Comments on the Sample Code:

In the line:

FirstWord = Request.Form("FirstSearchTerm")

The data posted from the search form (referred to as "FirstSearchTerm") is assigned to the variable "FirstWord".

In the line:

SecondWord = Request.Form("SecondSearchTerm")

The data posted from the search form (referred to as "SecondSearchTerm") is assigned to the variable "SecondWord".

In the line:

SearchStructure = Request.Form("Structure")

The data posted from the search form (referred to as "Structure") is assigned to the variable "SearchStructure".

In the line:

SearchDirection = Request.Form("Direction")

The data posted from the form (referred to as "Direction") is assigned to the variable "SearchDirection".

In the line:

SearchRange = Request.Form("Range")

The data posted from the form (referred to as "Range") is assigned to the variable "SearchRange".

Using these values, we then turn the search request into a Proximity Search:

SearchRequest = FirstWord & " {VIC :" & SearchRange

SearchRequest = SearchRequest & SearchStructre & SearchDirection

SearchRequest = SearchRequest & " " & SecondWord & "}"

SearchRequest simply combines the user entered variables into one variable who's value equals:

FirstWord {VIC :SearchRange SearchStructure SearchDirection SecondWord}

Date Searching

The Date Search searches information according to a date contained in a field. There are three types of date search: Single Range, Dual Range, and Date Comparison.

Usage:

Single range ("find all documents earlier than...")

Enter: {cal} Date: < 01-01-98

Find: documents where the date in the Date: field is before January 1, 1998.

Dual range ("find all documents from 1970 to 1980")

Enter: {cal} Born: >= 01-01-1970 and {cal} Born: <= 01-01-1980

Find: documents with dates in the Born field between 1970 and 1980.

Comparison ("find documents with dates from the last 30 days")

Enter: {cal} Date: {to} [ ] <= 30 days

Find: documents where the date in the Date field is <= 30 days from today.

Enter: {cal} Date:{to} Dec. 7, 1941 <= 2 months

Find: documents where the date is <= 2 months from December 7, 1941.

Enter: {cal} Date:{to} [ ] >= 1 year

Find: documents where the date in the Date field is >= 1 year from today.

Comments:

1. Dates of varying formats can be mixed in a file and will still be understood. For example, askSam can compare, sort and evaluate a file with dates such as July 30th, 1998, 30 JUL. 1998, 07/30/1998, and 07-30-98 mixed throughout the file.

2. If a date in an unrecognized form is included, askSam will return an error. If a date field is blank, askSam uses the system date.

3. The date searches in the askSam Engine are set up to deal with four digit years. This allows you to do searches of data over multiple centuries.

4. You can use the following relational operators with your date searches:

< less than

<= less than or equal to

= equal to

>= greater than or equal to

> greater than

<> not equal to

5. The system date can be used in a request. It is represented by [ ] (brackets). The example of the Comparison Date Search demonstrates how this works.

Sample Code - Single Range

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: DateSearch = Request.Form("Date")

11: DateDirection = Request.Form("Range")

12: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

13:

14: If asksam.IsFileOpened Then

15:

16: SearchRequest = "{Cal} Date: " & DateDirection & " " & DateSearch

17: Doc_Id = asksam.SearchFile(SearchRequest, 0)

18: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

19: Response.Write UserRecord

20:

21: asksam.CloseASFile

22:

23: End If

24: %>

Comments on the Sample Code:

In the line:

DateSearch = Request.Form("Date")

The data posted from the search form (referred to as "Date") is assigned to the variable "DateSearch".

In the line:

DateDirection = Request.Form("Range")

The data posted from the search form (referred to as "Range") is assigned to the variable "DateDirection".

We then turn the search request into a Single Range Date Search using DateSearch and DateDirection in the line:

SearchRequest = "{Cal} Date: " & DateDirection & " " & DateSearch

Sample Code - Dual Range

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: StartDate = Request.Form("FirstDate")

11: EndDate = Request.Form("SecondDate")

12: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

13:

14: If asksam.IsFileOpened Then

15:

16: SearchRequest = "{Cal} Born: >= " & StartDate & " and "

17: SearchRequest = SearchRequest & " {Cal} Born: <= " & EndDate

18: Doc_Id = asksam.SearchFile(SearchRequest, 0)

19: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

20: Response.Write UserRecord

21:

22: asksam.CloseASFile

23:

24: End If

25: %>

Comments on the Sample Code:

In the line:

StartDate = Request.Form("FirstDate")

The data posted from the search form (referred to as "FirstDate") is assigned to the variable "StartDate".

In the line:

EndDate = Request.Form("SecondDate")

The data posted from the search form (referred to as "SecondDate") is assigned to the variable "EndDate".

We then turn the search request into a Dual Range Date Search using StartDate and EndDate in the lines:

SearchRequest = "{Cal} Born: >= " & StartDate & " and "

SearchRequest = SearchRequest & " {Cal} Born: <= " & EndDate

Sample Code - Comparison

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: StartDate = Request.Form("FirstDate")

11: EndDate = Request.Form("SecondDate")

12: SearchDirection = Request.Form("Direction")

13: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

14:

15: If asksam.IsFileOpened Then

16:

17: SearchRequest = "{Cal} Date: {to} " & StartDate & " "

18: SearchRequest = SearchRequest & SearchDirection & " " & EndDate

19: Doc_Id = asksam.SearchFile(SearchRequest, 0)

20: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

21: Response.Write UserRecord

22:

23: asksam.CloseASFile

24:

25: End If

26: %>

Comments on the Sample Code:

In the line:

StartDate = Request.Form("FirstDate")

The data posted from the search form (referred to as "FirstDate") is assigned to the variable "StartDate".

In the line:

EndDate = Request.Form("SecondDate")

The data posted from the search form (referred to as "SecondDate") is assigned to the variable "EndDate".

In the line:

27: SearchDirection = Request.Form("Direction")

The data posted from the form (referred to as "Direction") is assigned to the variable "SearchDirection".

We then turn the search request into a Dual Range Date Search using StartDate, EndDate and SearchDirection in the lines:

SearchRequest = "{Cal} Date: {to} " & StartDate & " "

SearchRequest = SearchRequest & SearchDirection & " " & EndDate

Case Sensitive Searches

By default, askSam searches are not case sensitive. When you search for a word, the case of the letters comprising the word is irrelevant. The CASE command lets you define a case sensitive search. The CAPS command switches back to a non-case sensitive search.

Usage:

Syntax: {CASE} search request {CAPS}

Enter: WHO

Find: Documents containing either Who, who, or WHO

Enter: {CASE} WHO {CAPS}

Find: Documents containing only WHO

Comments:

If the case command is used in a search request containing a field name, the case of the field is also considered when retrieving a record. For example:

{CASE} ABC Computing {IN} Company[

{CASE} ABC Computing {IN} COMPANY{

will retrieve different sets of documents. In the first example, only records are retrieved where the field name "Company" is written with an upper case "C". The second example will only retrieve records where the field name "COMPANY" is written in all upper case letters.

If you wanted to ignore the case in the rest of your request, you would enter the request as follows:

{CASE} ABC Computing {CAPS} {IN} Company[

Sample Code:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

11:

12: If asksam.IsFileOpened Then

13:

14: Doc_Id = asksam.SearchFile("{Case} Who {CAPS}", 0)

15: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

16: Response.Write UserRecord

17:

18: asksam.CloseASFile

19:

20: End If

21: %>

The previous sample could have been written like this:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: Search = Request.Form("SearchTerm")

11: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

12:

13: If asksam.IsFileOpened Then

14:

15: SearchRequest = "{Case} " & Search " {Caps}"

16: Doc_Id = asksam.SearchFile(SearchRequest, 0)

17: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

18: Response.Write UserRecord

19:

20: asksam.CloseASFile

21:

22: End If

23: %>

Comments on the Sample Code:

One line 10:

Search = Request.Form("SearchTerm")

The data posted from the search form (referred to as "SearchTerm") is assigned to the variable "Search"

We then turn the search request into a Case Sensitive Search by adding the command

"{Case} " to Search in the line:

SearchRequest = "{Case} " & Search

Index Searches

Full-Text Indexing greatly speeds up searching in askSam files, especially in large files. With full-text indexing, you can search through a several hundred MB askSam file in a matter of seconds.

Usage:

If you index an askSam file, the askSam Engine will automatically use the index when searching that file. It is not necessary for you to modify your search request in any way.

Comments:

To index your file for use with the askSam Engine, you will need a copy of askSam Professional -- version 3.0H or later. Contact our Technical Department to get a copy (tech@askSam.com).

Sorting

The Sort command allows you to output documents in sorted order. askSam can sort your Documents alphabetically, numerically, or by date.

Usage:

Syntax: search request {SORT :parameters Fieldname1 :parameters Fieldname2}

Enter: OPEN {IN} Status[ {SORT :CD Date[ :L Name[ }

Find: Documents with "Open" in the Status field. The documents are returned in sorted order. They are sorted in descending date order and then by the last word in the name field. For example:

03/22/1998 Emma Collins

03/22/1998 Leon Wilson

02/14/1998 Harmeet Singh

Parameters:

C - sorts the Field by date (rather than alphabetically).

R# - sorts the Field numerically (# is the number of digits to sort on).

D - sorts the data in descending order (from Z-A or from 9-1 etc)

U - ignores the case (upper/lower) when sorting

I - ignores articles such as "the", "a", "an" when sorting

L - sorts on the last word in a field. Useful for name fields such as "John Smith"

Comments:

1. The Search Request should always precede the Sort request.

2. The Sort Command does not change the physical order of the Documents in your file. They are just displayed in a sorted order on your screen.

3. Dates of varying formats can be mixed in a file and will still be understood. For example, askSam can compare, sort and evaluate a file with dates such as July 30th, 1998, 30 JUL. 1998, and 07-30-98 mixed throughout the file.

4. There can only be on SORT command per request, but the sort command allows you to sort on multiple fields.

Sample Code:

<%@ Language=VBScript %>

File_Path = Server.MapPath("./")

File_Name = File_Path + "\bulletin.ask"

Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

If asksam.IsFileOpened Then

Doc_Id = asksam.SearchFile("{Sort :C Date:}", 0)

UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

Response.Write UserRecord

asksam.CloseASFile

End If

The sample could have been written like this:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: Search = Request.Form("SearchTerm")

11: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

12:

13: If asksam.IsFileOpened Then

14:

15: SearchRequest = Search & " {Sort :C Date:}"

16: Doc_Id = asksam.SearchFile(SearchRequest, 0)

17: UserRecord = asksam.LoadDoc(DT_DATA, FF_HTML, Doc_Id)

18: Response.Write UserRecord

19:

20: asksam.CloseASFile

21:

22: End If

23: %>

Comments on the Sample Code:

In the line:

24: Search = Request.Form("SearchTerm")

The data posted from the search form (referred to as "SearchTerm") is assigned to the variable "Search".

We then turn the search request into a date Sort by adding the command

" {Sort :C Date:}" to Search with the line:

25: SearchRequest = Search & " {Sort :C Date:}"

Component Application Programming Interfaces (APIs)

File Functions

OpenAsFile Function

Syntax:

OpenAsFile(filename, how, share)

Purpose:

Opens an existing askSam file.

Parameters:

filename

The name of the file you wish to open. This value can include path information.

how

Specifies how you wish to open the file.

ASOF_READ - Opens the file for Read Only access.

ASOF_READWRITE - Opens the file for Read and Write access.

ASOF_WRITE - Opens the file for Write Only access.

ASOF_NEW - Creates a new file with Read and Write access.

share

Determines how this file is to be shared with other openers of the file.

ASOF_READ - Others have Read access to the file.

ASOF_READWRITE - Others have Read and Write access to the file.

ASOF_WRITE - Others Write access to the file.

ASOF_EXCLUSIVE - Does not allow others to access the file. You have exclusive access to the file.

Returns:

True if the file is successfully opened.

False if the file cannot be opened. Use the GetLastAsError function for further information.

Comments:

After using the OpenASFile function, you will need to close the file using the CloseAsFile function. The askSam Engine only allows you to open a single file per instance of the askSam Object. To open multiple askSam files at the same time, you will need to create multiple askSam Objects using the Dim, Set, and CreateObject VB functions.

ASOF_NEW - Creates a new file with Read and Write access.

The share value can only be set to exclusive (ASOF_EXCLUSIVE) if no other user has the file open when the OpenASFile function is executed.

You need to include the ASKSAM.BAS file in any VB project that uses the askSam Database Engine.

In any ASP file that uses the askSam Database Engine, you will need to include the ASKSAM.ASP file. You can do this by using the ASP Include statement shown in the ASP example below.

Visual Basic Example:

26: Path$ = App.Path

27: File_Name = Path$ & "\Readme.ask"

28: Dim asksam As Object

29:

30: Set asksam = CreateObject(“ASKSAM.EngineCtrl.5”)

31: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

32:

33: If asksam.IsFileOpened Then

34:

35: Doc_Id = asksam.FirstDoc(DT_DATA)

36: RichText.TextRTF = asksam.LoadDoc(DT_DATA, FF_RTF, Doc_Id)

37:

38: asksam.CloseASFile

39:

40: Else

41:

42: Error_Id = asksam.GetLastASError()

43: RichText.TextRTF = asksam.ASErrorToString(Error_Id)

44:

45: End If

46: Set asksam = Nothing

Line 1 defines the pathway to the askSam file

Line 2 defines the filename and appends it to the pathway

Line 3 defines the variable asksam

Line 5 creates an instance of the asksam database engine

Line 6 opens the askSam file

Line 8 verifies that the askSam file is open

Line 10 retrieves the document handle of the first document in the askSam file.

Line 11 outputs the askSam document to the screen

Line 13 closes the askSam file

Line 17 retrieves the error id of the last error

Line 18 requests the error string for the error id and outputs it to the screen.

Line 21 frees up the memory used by the askSam instance.

Active Server Pages Example:

1: <%@ Language=VBScript %>

3:

5: <%

6: File_Path = Server.MapPath("./")

7: File_Name = File_Path + "\bulletin.ask"

9: Set asksam = Server.CreateObject(“ASKSAM.EngineCtrl.5”)

10: asksam.OpenASFile File_Name, ASOF_READ, ASOF_READWRITE

11:

12: If asksam.IsFileOpened Then

13:

14: Doc_Id = asksam.FirstDoc(DT_DATA)

15: Text = asksam.LoadDoc(DT_DATA, FF_TEXT, Doc_Id)

16: Response.Write "<CENTER> The first document in the file is displayed"

17: Response.Write Text

18: Response.Write "</CENTER>"

19:

20: asksam.CloseASFile

21:

22: Else

23:

24: Error_Id = asksam.GetLastASError()

25: Text = asksam.ASErrorToString(Error_Id)

26: Response.Write "<CENTER> The following error occurred: <P>"

27: Response.Write Text

28: Response.Write "</CENTER>"

29:

30: End If

31: Set asksam = Nothing

32: %>

Line 1 defines VBScript as the default scripting language for this page

Line 3 includes the default askSam constants.

Line 6 defines the pathway

Line 7 defines the filename and appends it to the pathway

Line 9 creates an instance of the asksam database engine

Line 10 opens the askSam file

Line 12 verifies that the askSam file is open

Line 14 retrieves the document handle of the first document in the askSam file.

Line 15 loads the document into the variable named Text

Line 17 outputs the document

Line 20 closes the askSam file

Line 24 retrieves the error id of the last error

Line 25 requests the error string for the error id

Line 27 outputs the error string

Line 31 frees up the memory used by the askSam instance.

Filename	The name of the file you wish to open. This value can include path information.
How	Specifies how you wish to open the file. ASOF_READ - Opens the file for Read Only access. ASOF_READWRITE - Opens the file for Read and Write access. ASOF_WRITE - Opens the file for Write Only access. ASOF_NEW - Creates a new file with Read and Write access.
Share	Determines how this file is to be shared with other openers of the file. ASOF_READ - Others have Read access to the file. ASOF_READWRITE - Others have Read and Write access to the file. ASOF_WRITE - Others Write access to the file. ASOF_EXCLUSIVE - Does not allow others to access the file. You have exclusive access to the file.
Group	The group name of the access level to this file.
password	The password for the group.

supervisor_password	The file supervisor password
group name	The group name of the group to be copied
new group name	The name of the new group to be created
new group password	The password of the new group

Overview of the askSam 5 Database Engine

About this Documentation

Characteristics of the askSam Database Engine

Functionality of the askSam Engine

System Requirements

Installing the askSam Database Engine

To install the askSam Engine you download from the Internet:

To install the askSam Database Engine from CD-Rom

Details about the Installation Process:

Configuring the Active Sever Page Example

Using the askSam Engine

Creating files for use with the askSam Engine

Documents and Outputting Documents

Document Handles

Accessing the Document Handle.

Using the askSam Engine in a Visual Basic program

Defining an object with the CreateObject command

Accessing the askSam Engine using OLE Automation

Visual Basic Sample Application

ASKSAM.BAS

Using the askSam Engine in Active Server Programming

Accessing the askSam Engine via Active Server Pages

Active Server Page Sample Application

ASKSAM.ASP

Search and Sort Commands

Boolean Searches

Wildcard Searches

Searching for Phrases

Fuzzy Searching

Searching in a Specific Field

Numeric Searching

Proximity Searching

Date Searching

Case Sensitive Searches

Index Searches

Sorting

Component Application Programming Interfaces (APIs)

File Functions