BASIC+ Commands

https://wiki.srpcs.com/display/Commands
Admin
BASIC+ is an extended BASIC programming language developed by Revelation Software that provides...
Tokens:947,379
Snippets:15,458
Trust Score:8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Directory Listing with InitDir and DirList

Source: https://wiki.srpcs.com/display/Commands/InitDir%2BStatement

This example demonstrates how to use InitDir to specify a directory and file mask, and then DirList to retrieve a list of matching filenames. It includes logic to process the returned list.

```BASIC+
/* The program gets the list of all *.DOC files in the C:\HISTORY\DOCS\LETTERS directory into list variable. 
It uses InitDir to indicate the directory and DirList() to return the filenames. 
Note the use of @FM and Col2() within the brackets. */
drive="C:\HISTORY\DOCS\LETTERS"
InitDir drive : "*.DOC"
loop
  list = DirList()
Until List = ""
  loop
    line = list[1,@FM]
    list[1,Col2()] = ""
  Until list = ""
  repeat
repeat
end
```

--------------------------------

### Search String for 'Starting With' Query

Source: https://wiki.srpcs.com/display/Commands/Btree.Extract%2BSubroutine?focusedCommentId=156008449

This example demonstrates how to construct a search string to extract keys of all rows where a specific field starts with a given character. The ']' indicator is used for this purpose.

```BASIC
srch_strng = "CITY":@VM:"S]":@FM

```

--------------------------------

### Example: Setting and Getting Character Format

Source: https://wiki.srpcs.com/display/Commands/GETCHARFORMAT

This example demonstrates how to set text, select a portion of it, apply formatting (bold and blue color) using SETCHARFORMAT, and then retrieve that formatting information using GETCHARFORMAT. It also shows how to reset the cursor position.

```script
Declare function Send_Message
 
Red = 255
Green = 255 * 256
Blue  = 255 * 65536
 
ApplyFormatTo = 1     // Selection
// Create some test text
x = Set_Property(@window:'.EDIT_AREA', 'TEXT', "This is a test...")
 
// Select "is a"
x = Set_Property(@window:'.EDIT_AREA', 'SELECTION', 6:@fm:4)
 
// Make the "is a" bold and blue
CharFormat = ''
CharFormat<1,1> = '1'
CharFormat<4>   = Blue
x = Send_Message(@window:'.EDIT_AREA', 'SETCHARFORMAT', ApplyFormatTo, CharFormat)
 
// Reset the cursor back to the beginning
x = Set_Property(@window:'.EDIT_AREA', 'SELECTION', 1:@fm:0)
 
// Get the format
x = Set_Property(@window:'.EDIT_AREA', 'SELECTION', 6:@fm:4)
charFormat = Send_Message(@window:'.EDIT_AREA', 'SETCHARFORMAT',ApplyFormatTo)
```

--------------------------------

### Example of using the FOOTER message

Source: https://wiki.srpcs.com/display/Commands/Set%2BPrinter%2BFOOTER

This example demonstrates the complete process of setting up headers and footers, including initializing the printer, defining footer text, setting column lengths and footers, and printing columnar text. It shows how to convert delimiters and use the Set_Printer function for various operations.

```Set_Printer
declare
function
Set_Printer
stat = Set_Printer("INIT") ;* Start printing
footer = "This is the main Footer Page 'P' File = 'F'"
colLen = "2,2,2"
colFooter = "Col1,Col2,Col3"
colText = "111,222,333/aaa,bbb,ccc/AAA,BBB,CCC"
Convert
delimiters
convert "," 
to @fm 
in colLen ; 
convert "," 
to @vm 
in colFooter
convert "," 
to @vm 
in colText ; 
convert "/" 
to @fm 
in colText
Set header to set the column positions
stat = Set_Printer("HEADER", "", colLen, "")
stat = Set_Printer("FOOTER", footer, colFooter) ;* Set footer
stat = Set_Printer("TEXTCOL", colText) ;* Print columnar text
stat = Set_Printer("TERM") ;* End printing
```

--------------------------------

### Get OpenInsight Installation Directory

Source: https://wiki.srpcs.com/display/Commands/RTI%2BOS%2BDirectory%2Bfunction%2BGetOIDirectory

Use this function to get the full path to the directory where OpenInsight is installed. This function does not accept any parameters.

```RTI Script
declare function RTI_OS_Directory
$Insert Logical

// returns the path to the directory where OpenInsight is installed
result = RTI_OS_Directory( "GetOIDirectory" )
```

--------------------------------

### Get Windows Directory Path

Source: https://wiki.srpcs.com/display/Commands/RTI%2BOS%2BDirectory%2Bfunction%2BGetWindowsDirectory

Call the RTI_OS_Directory function with 'GetWindowsDirectory' to get the path where Windows is installed. This method does not accept parameters.

```RTI Script
declare function RTI_OS_Directory

// returns the path to the directory where windows is installed
result = RTI_OS_Directory( "GetWindowsDirectory")

```

--------------------------------

### Set Printer LINESTYLE Example

Source: https://wiki.srpcs.com/display/Commands/Set%2BPrinter%2BLINESTYLE

This example demonstrates how to initialize the printer, set a custom line style to a 5-point solid line, and then print a line using these settings. It also shows how to terminate the printing session.

```BASIC+
/*The following example shows how to use the LINESTYLE message to print a bold line under the page header.*


```

```BASIC+
declare function Set_Printer
$insert OIPRINT_EQUATES
stat = Set_Printer("INIT");* Start printing
stat = Set_Printer("HEADER", "Test Header")

* Set line style to 5 point
stat = Set_Printer("LINESTYLE", PS_SOLID:@fm:5)

* Print line at top of the page
stat = Set_Printer("LINE", 0:@fm:1:@fm:7.5:@fm:1, 1)
stat = Set_Printer("TERM");* End printing
```

--------------------------------

### Format GUID Output with RTI_CreateGUID

Source: https://wiki.srpcs.com/display/Commands/RTI_CreateGUID%2BFunction

This example demonstrates how to format the output of RTI_CreateGUID using an optional outFormat argument. Different values for outFormat produce different GUID representations.

```BASIC+
retval = RTI_CreateGUID()
retval = RTI_CreateGUID(outFormat)
```

--------------------------------

### Set Printer PRINTQUALITY Example

Source: https://wiki.srpcs.com/display/Commands/Set%2BPrinter%2BPRINTQUALITY

This example demonstrates how to initialize printing, set the print quality to draft resolution using PRINTQUALITY, add text, and then terminate the printing process.

```BASIC+
/* The following example shows how to use the PRINTQUALITY message. */

declare function Set_Printer
stat = Set_Printer("INIT")* Start printing
stat = Set_Printer("PRINTQUALITY", 1)* draft resolution
stat = Set_Printer("TEXT", "Testing")
stat = Set_Printer("TERM")* End printing
```

--------------------------------

### Extract XML Schema Name Function Example

Source: https://wiki.srpcs.com/display/Commands/Extract_XML_Schema_Name%2BFunction

This example demonstrates how to use the Extract_XML_Schema_Name function. It reads an XML file into memory and then uses the function to get the corresponding XML schema file name.

```OpenInsight BASIC
/*
   After the Extract_XML_Schema_Name() function is called, the variable
   xml_schema_name will contain the value C:\orders_schema.xsd.
*/
 
declare function extract_XML_Schema_Name
filename = 'C:\ORDERS.XML'
OSRead filerec from filename then
       xml_schema_name = extract_XML_Schema_Name(  filename, filerec)
end
```

--------------------------------

### Set Printer PREVIEWMODE Example

Source: https://wiki.srpcs.com/display/Commands/Set%2BPrinter%2BPREVIEWMODE

This example demonstrates initializing the printer, setting the preview mode for faster printing, adding text, and terminating the printing process. Use PREVIEWMODE with value 2 for monochrome printing to speed up the process.

```BASIC+
declare function Set_Printer
stat = Set_Printer("INIT") ;* Start printing
stat = Set_Printer("PREVIEWMODE", 2) ;* speed up printing
stat = Set_Printer("TEXT", "Testing")
stat = Set_Printer("TERM") ;* End printing
```

--------------------------------

### Get Super Entities Example

Source: https://wiki.srpcs.com/display/Commands/Repository%2BFunction%2BGETSUPER

This example demonstrates how to use the Repository function GETSUPER to find entities that are 'super' (parents) to a specific stored procedure. It includes error handling by checking the status after the call. Remember to call Get_Status after Repository.

```OpenInsight
/* Return entities "super" (parent) to the CENTERWINDOW stored procedure into the variable called result */
Declare Function Get_Repos_Entities, Repository, Get_Status
AppID = @APPID<1> ;* current application
TypeID = "STPROC" ;
ClassID = "" ;
Stored_Proc_Name = 'CENTERWINDOW'
entid = AppID : '*' : TypeID : '*' : ClassID : '*' : Stored_Proc_Name

result = Repository("GETSUPER", entid)
/*  result now contains a field mark delimited list of entities super (parent) to the CENTERWINDOW stored procedure.
   For a stored procedure this would be the stored procedure executable (STPROCEXE), if the stored procedure has been compiled.  */

If Get_Status(ErrCode) then
  call msg('@window', 'Error Message returned: ' : ErrCode)
end
```

--------------------------------

### Prepare and Evaluate Data with XREF

Source: https://wiki.srpcs.com/display/Commands/XREF%2BSubroutine

This example demonstrates preparing an array of data, converting it to uppercase, and then evaluating it using the XREF subroutine with custom delimiters and stop lists. Ensure data is converted to uppercase if the system stop list is used.

```OpenInsight
declare subroutine Xref, Toupper, Msg

array = "Revelation Software, Inc."
array<-1> = "Ralph Waldo Emerson; writer"
array<-1> = "Phil Rizzuto's spouse":@FM:"Dom Dimaggio"

delimiters = ",';."
stop_list = "s":@VM:"S"* to ignore the apostrophe s
mode = 2

TRANSFER array to @ANS
Toupper(@ANS)
Convert @TM:@SVM:@VM:@FM:@RM to @VM:@VM:@VM:@VM:@VM in @ANS

Xref(@ANS, delimiters, stop_list, mode)

text = QUOTE(@ANS)
Msg(@window, text)
```

--------------------------------

### Get Printer CANCEL Example

Source: https://wiki.srpcs.com/display/Commands/Get%2BPrinter%2Bfunction%2BCANCEL

This example shows how to use the CANCEL message with Set_Printer and Get_Printer to manage a print job and detect user cancellation. It initializes printing, reads data, checks for cancellation, and terminates the print job.

```Revelation BASIC
/* The following example shows how to use the CANCEL message. */

declare function Set_Printer, Get_Printer
stat = Set_Printer("INIT") ;* Start printing

loop
   readnext key else done = 1
until done
   cancelled = Get_Printer("CANCEL")
   if cancelled then
      done = 1
   end else
      Set_Printer("TEXT",'More text to print': key)
   end
repeat

stat = Set_Printer("TERM") ;* End printing
```

--------------------------------

### Set Printer TRUETYPE Mode Example

Source: https://wiki.srpcs.com/display/Commands/Set%2BPrinter%2BTRUETYPE

This example demonstrates initializing the printer, setting TrueType download mode, printing text, and terminating the printing session. Always check the return value of Set_Printer to ensure compatibility.

```BASIC
declare function Set_Printer
stat = Set_Printer("INIT") ;* Start printing
stat = Set_Printer("TRUETYPE", 2) ;* download
stat = Set_Printer("TEXT", "Testing")
stat = Set_Printer("TERM") ;* End printing
```

--------------------------------

### Example Usage of Make.List Subroutine

Source: https://wiki.srpcs.com/display/Commands/Make.List%2BSubroutine

Demonstrates how to use the Make.List subroutine to create a selectable list of customer keys. It includes file opening, error handling, and saving the generated list.

```subroutine
subroutine make_list_example(parent)

Declare Function Unassigned, Get_Status, Get_Property
Declare Subroutine Msg, MAKE.LIST, fsmsg, Set_Status, Save_Select

$Insert Logical
$Insert Msg_Equates

* Initialize Variables
errCodes = ""
errFlag = ""

* Determine Parent Window
If Unassigned(parent) Then parent = @Window
frame = Get_Property(parent,"MDIFRAME")
If frame Then parent = frame

* Open Files
Open "CUSTOMER" To f_customers Then
  Open "DICT.CUSTOMERS" To d_customers Else
    errText = "Unable to open the Customers Dictionary file."
    errFlag = TRUE$
  End
End Else
  errText = "Unable to open Customers file."
  errFlag = TRUE$
End

If errFlag Else

    * A List of Customer keys
  custList = "1" : @vm : "2" : @vm : "22" : @vm : "26"

    * Create the List in Cursor 0 and if successful save the list
  Set_Status(0)
  MAKE.LIST(0, custList, f_customers, d_customers)
  If Get_Status(errCodes) Then
    FSMsg(errCodes)
  End Else
    Set_Status(0)
    Save_Select("","MAKE_LIST_TEST","","")
    If Get_Status(errCodes) then
      FSMsg(errCodes)
  end
  End
End

if errFlag Then
  msgStruct = ""
  msgStruct<MCAPTION$> = "Error"
  msgStruct<MICON$> = "H"
  msgStruct<MTEXT$> = errText :  "|Error Code: " : @file.error<1>
  Msg(Parent,msgStruct)
end

return

```

--------------------------------

### Get Current Event

Source: https://wiki.srpcs.com/display/Commands/Get_Current_Event%2BFunction

Call this function to retrieve the name of the current event. For example, if called during a button click, it would return "CLICK".

```Revelation
declare function Get_Current_Event
thisEvent = Get_Current_Event()
```

--------------------------------

### Demonstrate Push.Session Usage

Source: https://wiki.srpcs.com/display/Commands/Push.Session%2BSubroutine

This example shows how to declare and use the Push.Session subroutine to save environment parameters before calling another subroutine and then restoring them with Pop.Session.

```BASIC+
/* The following code demonstrates the use of Push.Session */
Declare subroutine Push.Session, Pop.Session, Msg
Push.Session(cursor, sentence, record, id, dict, mv)
* Call a subroutine that modified the environment parameters.
Gosub Change_Environ
Pop.Session(cursor, sentence, record, id, dict, mv)
```

--------------------------------

### Inet_Trace HTTP Headers Output

Source: https://wiki.srpcs.com/display/Commands/Inet_Trace%2BFunction

This is an example of the HTTP headers returned when OECGI.EXE is properly installed and Inet_Trace is executed. It provides debugging information such as query string and server details.

```text
CONTENT_LENGTH = 0
CONTENT_TYPE =
GATEWAY_INTERFACE = CGI/1.1
HHTTPS = off
HTTP_ACCEPT = image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword, */*
HTTP_COOKIE =
HTTP_FROM =
HTTP_REFERER =
HTTP_USER_AGENT = Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)
PATH_INFO = /INET_TRACE
PATH_TRANSLATED = C:\Inetpub\wwwroot\INET_TRACE
QUERY_STRING = FOO=BAR
REMOTE_ADDR = 127.0.0.1
REMOTE_HOST = 127.0.0.1
REMOTE_IDENT =
REMOTE_USER =
REQUEST_METHOD = GET
SCRIPT_NAME = /cgi-bin/oecgi.exe
SERVER_NAME = 127.0.0.1
SERVER_PORT = 80
SERVER_PROTOCOL = HTTP/1.1
SERVER_SOFTWARE = Microsoft-IIS/5.1
SERVER_URL =
```

--------------------------------

### Call PRINTSETUP Service

Source: https://wiki.srpcs.com/display/Commands/PRINTSETUP%2BService

Use the Utility function to call the PRINTSETUP service. This will display the Windows Print Setup dialog. No specific setup or imports are required beyond the standard Utility function availability.

```Utility
retval = Utility("PRINTSETUP")
/* produces a dialog similar to the following */
```

--------------------------------

### Example 1: Creating and Manipulating Variables

Source: https://wiki.srpcs.com/display/Commands/RTI_JSON%2BFunction

Demonstrates creating various types of variables (object, number, string, boolean, date, regex, array) and then setting and getting values from an array.

```APIDOC
## Example 1

```
myObject = RTI_JSON(``''``, ``'New'``, ``'OBJECT'``) ; * generic object
myNumber = RTI_JSON(``''``, ``'New'``, ``'Number'``, ``'21'``)
myString = RTI_JSON(``''``, ``'New'``, ``'String'``, ``'Hello World'``)
myBool   = RTI_JSON(``''``, ``'New'``, ``'Boolean'``, ``'1'``)
mydate   = RTI_JSON(``''``, ``'New'``, ``'Date'``, date(), time()) ; * javascript date object
myRegEx  = RTI_JSON(``''``, ``'New'``, ``'REGEXP'``, ``"\bt[a-z]+\b"``) ; * regular expression
myArray  = RTI_JSON(``''``, ``'New'``, ``'ARRAY'``, ``'"A","B","C"'``)
x = Rti_JSON(MyArray, ``'SetValue'``, ``'[3]'``, ``'D'``)
v1 = Rti_JSON(MyArray, ``'GetValue'``, ``'[0]'``) ;* v1 should now contain “A”
```
```

--------------------------------

### Example: Setting Window Background, Button Text, and Font

Source: https://wiki.srpcs.com/display/Commands/Set_Property%2BFunction

Demonstrates calling the Set_Bulk_Properties subroutine to simultaneously set the window's background color, a button's text, and the button's font. Requires the rgb function to be declared.

```OpenInsight
declare subroutine set_bulk_properties
declare function rgb
controls = "@window" : "@rm" : "@window" : ".Button_OK" : "@rm" : "@window" : ".Button_OK"
propnames = 'BACKCOLOR' : "@rm" : 'TEXT' : "@rm" : 'FONT'
values = rgb(255,255,0) : "@rm" : 'OK' : "@rm" : 'Tahoma'
set_bulk_properties( controls, propnames, values)
```

--------------------------------

### Get My Documents Path

Source: https://wiki.srpcs.com/display/Commands/RTI%2BOS%2BDirectory%2Bfunction%2BGetMyDocuments

Call the RTI_OS_Directory function with the 'GetMyDocuments' parameter to obtain the path to the 'My Documents' directory. This function returns the full path to the directory where OpenInsight is installed.

```RTI Script
declare function RTI_OS_Directory
$Insert Logical

// returns the path to the directory where OpenInsight is installed
result = RTI_OS_Directory( "GetMyDocuments" )
```

--------------------------------

### Execute U2 Command with U2_ExecProc

Source: https://wiki.srpcs.com/display/Commands/U2%2BFunctions%2Bin%2BOI%2BU2%2BExecProc

This example demonstrates how to execute a U2 command using the U2_ExecProc function. It sets up the VolumeID, Command, and Buffer variables, then calls the function. The returned buffer is trimmed for display.

```U2 Basic
declare function u2_execproc

VolumeID = 'mylaptop6100b:UV'

Command = 'RUN BP LIST.INDEX'

buffer = ''

result = u2_execProc(VolumeID, Command, Buffer)

* get rid of extra spaces

buffer = trim(buffer)

x = msg(@window, trim(Buffer) )
```

--------------------------------

### Declare and Call Get_App_Info

Source: https://wiki.srpcs.com/display/Commands/Get_App_Info%2BFunction

Declares the get_app_info function and then calls it with 'EXAMPLES' as the application name. The result is stored in the application_information variable.

```Revelation Basic
declare function get_app_info
application_information = Get_App_Info('EXAMPLES')
```

--------------------------------

### Get Default Character Value

Source: https://wiki.srpcs.com/display/Commands/GetDefaultCharacter%2BFunction

Use this function to retrieve the default character value. This value is used when a Unicode character cannot be mapped to an ANSI character. No setup or imports are required.

```Revelation Basic
declare function GetDefaultCharacter
* char will contain the default character value when a Unicode character
* does not map to an ANSI character
char = GetDefaultCharacter()
```
Tokens:
Raw