Description works with OLE objects

Creation OLE of object

For work with OLE objects it is necessary to execute the following actions ( for example in the environment of VisualBASIC project):

1.To connect library GP_TERM.TLB or GP_Term.TLB

To specify a path to library on a disk (the button < BROWSE … >)

The chosen library in the list will be marked by "checkbox".

Save connection.

2. Declare variables
DIM OBJC AS GP_TERM.Connector
DIM OBJD AS GP_TERM.Document

Set OBJC =NEW GP_TERM.Connector
Set OBJD = OBJC.GetTerminal("BRIZ")
Set OBJC = Nothing

At the end of work with COM object it is necessary to remove the created object:

Set OBJD=NOTHING

The procedure with the program using BRIZ OLE/COM object

For working of the program with OLE/COM objects should be started servrer programm, which processes messages, i.e. a call of procedure GPTERM.StartMessageMap.

INCLUDE GPTERM.COMMON

CALL GPTERM.StartMessageMap("", "", "", "")

Detailed description is resulted in section STARTMESSAGEMAP

Such procedure can carry out a role of the starting program. For a call of a workstation program use GPTERM.SHELLEXECUTEEX  or AJ.DOS.TASK

Methods of BRIZ COM objects

GP_TERM.Connector

COM object GP_TERM.Connector have one method - GetTerminal that returns GP_TERM.Document object.

DIM OBJC AS GP_TERM.Connector
DIM OBJD AS GP_TERM.Document

Set OBJC =NEW GP_TERM.Connector
Set OBJD = OBJC.GetTerminal("")
 Set OBJC = Nothing
.......

GetTerminal [Name][;CommandLine]

Name  - Session name in ROT (Running object table). If Name is not present in ROT or is empty then Connector.GetTerminal  starts new instance of BRIZ and register it as BRIZxxxx, where xxxx is BRIZ HInstance.
CommandLine - Command line. Connector.GetTerminal executes it if need setup connection and other BRIZ settings.

Examples

Name = ""     - starts new instance of BRIZ with default connection.
Name = "MyName"     - returns  BRIZ registered as MyName. If BRIZ "MyName" not exist then starts new instance of BRIZ and register it as "MyName" 
  OBJC.GetTerminal("MyName")

CommandLine = ";-COMMNUMMYCONNECTION -HIDE"    -  starts new instance of BRIZ with connection MYCONNECTION in hidden view 
    OBJC.GetTerminal(";-COMMNUMMYCONNECTION -HIDE")

CommandLine = ";-INCLUDE="myProfile.txt""   starts new instance of BRIZ and retrieve commandline options from file myProfile.txt 
OBJC.GetTerminal(';-INCLUDE="myProfile.txt"')

 

GP_TERM.Document

COM object GP_TERM.Document has the methods intended for work with the server, with the files and for data transformations.

Procedures for working with terminal

Close Closing of a session with the server
Connect Connecting to the server
ConnectEx Parses string as command line and then connecting to the server
DumpStart To begin recording a dump
DumpStop To stop recording a dump
GetInput Returns a sequence of the symbols which have come from server and placed on screen
IsConnected Checks presence of the established communication(connection)
ParseCommandLine Parses string as command line
ResetSubWait To reset expectation of executing of PICK-procedure
ResetTCLWait To reset expectation of executing of TCL-command
SendChar To send a symbol
SendLine To send a string of symbols
SetNextDlgParent To appoint a parent window
SetOutputVisibility Establishes a mode of display on the terminal window
TermShow Shows the terminal window
IsScriptOn Returns script execution status.
ExecuteScript Executes script.
AbortScript Aborts script execution.

Procedures for working with server

DOSYSTEM Performance of SYSTEM command on server
ENDMESSSAGEMAP To finish an operation cycle of messages on server
EXECSUB To execute PICK-procedure
ExecSUBNet To execute PICK-procedure
EXECSUBEX To execute PICK-procedure
EXECTCL To execute TCL command
EXECLISTTAB To execute ListTab command
EXECTCLEX To execute the list of TCL commands
EXECTCLCAP To execute TCL command without a conclusion of results to the screen
EXECTCLCAPEX To execute the list of TCL commands without a conclusion of results to the screen
GETACTIVELIST Returns the active list
GETLIST Reads item from a file
GetListEx To receive the list as a result of performance of  TCL commands
GETSUBRESULT Returns result of executing of PICK procedure
GETTCLRESULT Returns result of executing of TCL command
GETLISTTABRESULT Returns result of executing of TCL command, divided by symbols of tabulation
ISMESSAGEMAPON Checks process of processing of messages on
SAVELIST To save the list (to write into a file)
SaveListNet To save the list (to write into a file)
SMMCmd Executes method throug StartMessageMap procedure.

Work with files

CLOSEPICKFILE Closing of a PICK-file
DELETEFromPickFILE Removal of items from a PICK-file
ITEMEXIST Checks existing of item in a file
OPENPICKFILE To open a PICK-file
READPICKFILE Reading of all items from a PICK-file without opening a file
READITEM Reading of items on a key from a PICK-file without opening a file
READFromPick Reading of items from a PICK-file
ReadFromPickEx Reading N-th of number of items from a PICK-file
READVFromPick Reading of value of the given attribute from items in a PICK-file
ReadVFromPickEx Reading of value of the given attribute from N-th numbers of items of a PICK-file
ReadVCFromPickEx Reading of values under the list of Attributes from N-th numbers of items of a PICK-file
READUFromPick Reading of items of a PICK-file with locking
ReadUFromPickEx Reading N-th of number of items from a PICK-file with locking
READVUFromPick Reading of value of the given attribute from a PICK-file with locking
ReadVUCFromPickEx Reading of values under the list of Attributes from a PICK-file with locking
ReadVUFromPickEx Reading of values of the given attribute from items of a PICK-file with locking
ReadKFromPickEx Reading N-th of number of items with keys from a PICK-file
ReadKADFromPickEx Reading of group of items under the list of names of attributes with keys from a PICK-file
ReadKADUFromPickEx Reading groups of items under the list of names of attributes with keys from PICK-file with locking
ReadKVFromPickEx Reading of the given attribute from N-th numbers of items of a PICK-file with retrieving of keys
ReadKVCFromPickEx Reading of the list of numbers of attributes from N-th numbers of items of a PICK-file with retrieving of keys
ReadKUFromPickEx Reading N-th of number of items with keys from a PICK-file (with locking)
ReadKVUFromPickEx Reading of the given attribute with keys from N-th numbers of items of a PICK-file
ReadKVCUFromPickEx Reading the list of numbers of attributes with keys from N-th numbers of items of a PICK-file
RELEASELOCKEDFILE To take off locking from a file
ReleaseLockedItems To take off locking from the given items
ReleaseLockeds To take off locking from all files
RESETACTIVELIST Reset of the active list
SELECTOPENPICKFILE To open a file and to read items from a file
SELECTPICKFILE To read items from a file
SSELECTOPENPICKFILE To open a file and to read sorted items from a file
SSELECTPICKFILE To read sorted items from a file
WriteToPick To write in a PICK-file items on a key
WriteToPickEx To write in a PICK-file group of items
WriteVToPick To write new value of attribute in items of a PICK-file
WriteVToPickEx To write new value of attribute for group of items of a PICK-file
WRITEUToPick To write item a PICK-file with locking
WriteUToPickEx To write group of items of a PICK-file with locking
WriteVUToPick To write new value of attribute of item of a PICK-file with locking
WRITEVUToPickEX To write new values of attributes of group of items of a PICK-file with locking

Functions of data transformation

ARRAYTOSTRING Transforms a array to a string with separators
ARRAYTOSTRINGEX Transforms a array to a string with separators
COUNTOCCUR Counts up of recurrences of a substring
ConvertToSubArray, ConvertToSubArrayNet Transforms a array of string to a array of arrays of string
ConvertToSubArrayEx, ConvertToSubArrayExNet Transforms a string to a array of arrays by the given separators
ICONV To execute function Iconv
INDEXSUBSTRING Returns position N-th of entry substring in a string
GETDATEFromPick Transforms date from PICK-format
GETTIMEFromPick Transforms time from PICK-format
OCONV To execute Oconv (on server side)
StringToArray Transforms a string with separators to a array
StringToArrayEx Transforms a string to a array of arrays by the given separators
SETTIMEToPick Transforms date to a PICK-format
SETDATEToPick Transforms time to a PICK-format

Functions for working with arrays

ARRAYDELELEMENT To remove an element from a array
ARRAYINSELEMENT To insert an element into a array
ARRAYFIND Search of an element in array
ARRAYFINDEXACTLY Search of an element in array
SortArray, SortArrayNet Sorting a array
SortArray2, SortArray2Net Sorting a array with the subordinate

Functions of work with Lists

LISTMAKERADDLIST To add values in the list
LISTMAKERANDLIST To execute logic operation "AND"
LISTMAKERAPPENDLIST To update values in the list
LISTMAKERBEGINCONT Selects elements from the list, Which begin with the given context
LISTMAKERCONTLIST Selects elements from the list, Which contain the given context
LISTMAKERCREATELIST To create the list
LISTMAKERDELETELIST To remove the list
LISTMAKERDUPLICATELIST To create a copy of the list
LISTMAKERENDCONT Selects elements from the list, which  ended on the given context
LISTMAKERFILLOBJECT To fill in object by the data from the list
LISTMAKERGETLISTINFO To receive the information about the list
LISTMAKERGETLISTSINFO To receive the information about all lists
LISTMAKERGETLISTASARRAY To obtain the data from the given list as array
LISTMAKERGETLIST To obtain the data from the given list as string
LISTMAKERLOADLIST To load the data from a file into the specified list
LISTMAKERLOADPICKLIST To load the data from the given items of a file into the specified list
LISTMAKERMASKLIST To generate the list by a mask list
LISTMAKERNBEGINCONT Selects elements from the list, which not begin with the given context
LISTMAKERNCONTLIST Selects elements from the list, which not contain the given context
LISTMAKERNENDCONT Selects elements from the list, which not ended on the given context
LISTMAKERNMASKLIST To generate the list, excepting values in Masks list
LISTMAKERNOTLIST To execute logic operation "NOT"
LISTMAKERORLIST To execute logic operation "OR"
LISTMAKERSAVELIST To save the list
LISTMAKERSETLISTASARRAY To create list from array of strings
ListMakerSetListAsArrayNet To create list from array of strings
LISTMAKERSETLIST To fill in the list values from a string, which elements are divided by the specified symbol
LISTMAKERSAVEPICKLIST Save the information from the list in a PICK-file in item with the given name
LISTMAKERSORTLIST To sort the list
LISTMAKERSQUISELIST To optimize internal structures of the list
LISTMAKERUNIQUELIST To create unique values from the list
LISTMAKERXORLIST To execute logic operation "XOR"

Functions of work with TI_Tables

SPRCREATE To create the table
SPRDELETE To remove the table
SPRDOSUB To execute a method(subroutine) The table
SPRDOFN To execute a method(function) of the table
SPRFILLBYARRAY Fills into a array the data from the table
SPRFILLOBJECT Places and decodes the information from the table into the specified object
SPRFILLBYDISP Fills the specified object by the information from the table
SPRGETINFO Obtains the information about the table
SPRGETINFOS Obtains the information about the tables
SPRGETITEM To receive string value from the table
SPRFINDITEM Searchs lines of the table
SPRFINDNEXTITEM Searchs the next line of the table
SPRGETVALUES To receive values of the fields of the table
SPRGETVALUESEX To receive values of the fields of the table
SPRSETITEM To establish string value of the table
SPRINSERTITEM To insert an element into the table
SPRLOADFromPick Loads the table from a PICK-file
SPRREPLACEOBJECT Places the information from the table in specified object

Object GP_TERM.AutoSizing

ADDSETMAIN To establish the"main" window concerning which scaling and calculation of a position is made
ADDWND To add a window in processing
DELETEWND To remove a window
DELETEWNDEX To remove a window with specification of the "main" window
REINITSIZE Keeps the current size of a window as initial
RESET Carries out full initialization of the sizes object AutoSizing, Including the"main" window
SETMAXPOS To establish maximum positions of a window
SETMAXSIZE To establish the maximum sizes of a window
SETMINPOS To establish the minimal positions of a window
SETMINSIZE To establish the minimal sizes of a window
SETNEWSIZE To establish the new size of a window
SETNEWSTYLE To establish new style of processing of a window
UPDATESIZE To update the size (OnSize or OnSizing)

Functions of work with servers COMMON

NAMEDDATAGET Takes the named data from COMMON
NAMEDDATARESET To remove all named data from COMMON
NAMEDDATADELETE To remove the named data from COMMON
NAMEDDATASET To establish the named data from COMMON

Properties

WAITCOUNT Sets delay by quantity of manipulations
WAITTIME Sets delay
HWND Sets descriptor of a window of the terminal
HWNDVIEW Sets descriptor of a window of viewing