RACRetrieve
Display transaction from archive.
Syntax
hwnd The parent window to contain this application.
Key1 Search data for Key1.
Key2 Search data for Key2.
KeyID Search data for KeyID.
startpage Page to begin display of form set.
Remarks
Display transaction from archive, similar to RACRetrieveArchive except that it does not call RACInit, RACInit must be called before this function.
Files
Include: racapi.h Source: RACVIEW.C Code Declarations
int _RACAPI RACRetrieve(HWND hwnd, char *Key1, char *Key2, char *KeyID, int startpage);
Visual Basic Declaration
Private Declare Function RACRetrieve Lib "racw32.dll" _ (ByVal hwnd As Long, _
RACFilterPageForDisplay, RACProcessError, RACSetCurSession, RACSetStatus
RACRetrieveArchive
View form set specified.
Syntax
hwndParent The parent window to contain this application.
Key1 Search data for Key1.
Key2 Search data for Key2.
KeyID Search data for KeyID.
startpage set beginning page
location
Set screen location.
0 = Left half display (default) 1 = Right half display 2 = Top half display 3 = Bottom half display 4 = normal window 5 = maximized window
Remarks
It is assumed that the window's handle passed represents another application's main window. We'll create a frame window to contain the form set view and start the entry system after usual initialization.
See the <ArcRet> INI group to determine which fields are matched with Key1, Key2, and KeyID.
Returns
If successful, the handle of our desktop window is returned. On failure, zero will be returned and the caller should use RACGetStatus to retrieve the last know error code. Error code values are defined in RACAPI.H.
Files
Include: racapi.h Source: RACVIEW.C Code Declarations
HWND _RACAPI RACRetrieveArchive(HWND hwndParent, char *Key1,
char *Key2,
int startpage, int location);
Visual Basic Declaration
Private Declare Function RACRetrieveArchive Lib "racw32.dll" _ (ByVal hwndParent As Long, _
ByVal Key1 As String, _ ByVal Key2 As String, _ ByVal KeyID As String, _ ByVal startpage As Long, _ ByVal location As Long) As Long
Calls
RACRetrieveArchiveStat
RACRetrieveArchiveHab
View form set specified.
Syntax
hab Anchor block. In Windows, it is the instance handle.
Key1 Search data for Key1.
Key2 Search data for Key2.
KeyID Search data for KeyID.
startpage set beginning page
location
Set screen location.
0 = Left half display (default) 1 = Right half display 2 = Top half display 3 = Bottom half display 4 = normal window 5 = maximized window
Remarks
Is identical to RACViewByKey except the application instance is passed instead of a window's handle. Actually, RACRetrieveArchiveHab uses the window's handle only to obtain the application instance.
Returns
If successful, the handle of our desktop window is returned. On failure, zero will be returned and the caller should use RACGetStatus to retrieve the last know error code. Error code values are defined in RACAPI.H.
Files
Include: racapi.h Source: RACVIEW.C Code Declarations
HWND _RACAPI RACRetrieveArchiveHab(HAB hab, char *Key1,
char *Key2, char *KeyID, int startpage,
Visual Basic Declaration
Private Declare Function RACRetrieveArchiveHab Lib "racw32.dll" _ (ByVal hInstance As Long, _
ByVal Key1 As String, _ ByVal Key2 As String, _ ByVal KeyID As String, _ ByVal startpage As Long, _ ByVal location As Long) As Long
Calls
RACRetrieveArchiveStat
RACSave
Save transaction.
Syntax
int RACSave(void)
Remarks
Save the current transaction returns SUCCESS if the transaction was saved or if no transaction was current and needed to be saved.
Files
Include: racapi.h Source: RACTERM.C Code Declarations
int _RACAPI RACSave(void);
Visual Basic Declaration
Private Declare Function RACSave Lib "racw32.dll" () As Long typedef
typedef int (_RACAPIPTR RACSAVE) (void);
Calls
RACGetSession
RACSaveAsProxy
Save the current form set in the current AFEData structure into a proxy file.
Syntax
int RACSaveAsProxy(HINSTANCE hab, HWND hwnd,
VMMHANDLE menuH)
Parameter Description
hab Anchor block or instance handle for Windows.
hwnd Handle of window.
menuH Menu handle.
Remarks
Save the current form set in the current AFEData structure into a proxy file.
Files
Include: racapi.h Source: RACDATA.C Code Declarations
int _VMMAPI RACSaveAsProxy(HAB hab, HWND hwnd, VMMHANDLE menuH);
Visual Basic Declaration
Private Declare Function RACSaveAsProxy Lib "racw32.dll" _ (ByVal hInstance As Long, _
ByVal hWnd As Long, _
ByVal menuH As Long) As Long
Calls
RACGetSession
RACSetCaptionOff
Set caption off for this window.
Syntax
void RACSetCaptionOff(HWND hwnd)
Parameter Description
hwnd Handle of window.
Remarks
Set caption off for this window.
Files
Include: racapi.h Source: RACPROC.C Code Declarations
void _RACAPI RACSetCaptionOff(HWND hwnd);
Visual Basic Declaration
Private Declare Sub RACSetCaptionOff Lib "racw32.dll" _ (ByVal hwnd As Long)
typedef
typedef void (_RACAPIPTR RACSETCAPTIONOFF) (HWND hwnd);
Calls
RACGetSession
RACSetCaptionOn
Set caption on for this window.
Syntax
void RACSetCaptionOn(HWND hwnd)
Parameter Description
hwnd Handle of window.
Remarks
Set caption on for this window.
Files
Include: racapi.h Source: RACPROC.C Code Declarations
void _RACAPI RACSetCaptionOn(HWND hwnd);
Visual Basic Declaration
Private Declare Sub RACSetCaptionOn Lib "racw32.dll" _ (ByVal hwnd As Long)
typedef
typedef void (_RACAPIPTR RACSETCAPTIONON) (HWND hwnd);
Calls
RACGetSession
RACSetCmdLineArg
This allows historical command line options for AFEMAIN program to be passed to RACInit.
Syntax
int RACSetCmdLineArg(int argc, char* argv[ ])
Parameter Description
argc Number of parameters.
argv Array of pointers that contain the parameters.
Remarks
This allows historical command line options for AFEMAIN program to be passed to RACInit. Parameters are identical to those of a c program's main function.
The pointer to the structure is initially NULL but it's filled by the RACSetCmdLineArg function. The memory for the structure is static but there is a linked list's handle that is created via VMMCreateList. This handle will not survive RACTerminate. Therefore, RACSetCmdLineArg will need to be called before each RACInit.
Returns
int _RACAPI RACSetCmdLineArg(int argc, char *argv[]);
Visual Basic Declaration
Private Declare Function RACSetCmdLineArg Lib "racw32.dll" _ (ByVal argc As Long, _
ByVal argv As Long) As Long typedef
typedef int (_RACAPIPTR RACSETCMDLINEARG)
(int argc, char *argv[]);
Example
Valid command line options
-INI or /INI - set the INI FILE.
-MODE or /MODE - set to one of the following to etrieve WIP -USERID or /USERID - set the user ID
-HD or /HD - set help debug flag -MENU or /MENU - set the menu file.
Calls
RACSetIniFile
RACSetCurSession
Set this window to be the current session.
Syntax
int RACSetCurSession(HWND hwnd)
Parameter Description
hwnd Handle of window
Remarks
Set the main frame window's handle (hwndMainFrame variable) if we have a valid session for the handle passed.
Files
Include: racapi.h Source: RACDATA.C Code Declarations
int _RACAPI RACSetCurSession(HWND hwnd);
Visual Basic Declaration
Private Declare Function RACSetCurSession Lib "racw32.dll" _ (ByVal hWnd As Long) As Long
typedef
typedef int (_RACAPIPTR RACSETCURSESSION)(HWND hwnd);
Calls
RACGetSession, RACSetStatus
RACSetHook
Establish Windows message hook.
Syntax
void RACSetHook(void)
Remarks
This installs RACHookProc as a Windows compatible message hook. See that function for more information.
Files
Include: racapi.h Source: RACHOOK.C Code Declarations
void _RACAPI RACSetHook(void);
Visual Basic Declaration
Private Declare Sub RACSetHook Lib "racw32.dll" ()
RACSetIniFile
Sets the INI file path name used by RACLib functions.
Syntax
int RACSetIniFile(char* iniFile)
Parameter Description
iniFile File path name of INI file.
Remarks
Sets the INI file path name used by RACLib functions. A string is set within RACLib that is used by the RACInit function.
Returns
RAC_SUCCESS (0) is always returned.
Files
Include: racapi.h Source: RACINIT.C Code Declarations
int _RACAPI RACSetIniFile(char *iniFile);
Visual Basic Declaration
Private Declare Function RACSetIniFile Lib "racw32.dll" _ (ByVal iniFile As String) As Long
typedef
typedef int (_RACAPIPTR RACSETINIFILE) (char *iniFile);