Ingres CL GV
From Ingres Community Wiki
|
Ingres Compatability Library |
Compatibility Library Specification GV
Abstract
This is the specification of the GV facility provided by the compatibility library.
Revision: 1.0, 2-Jan-91
Document History
- Revision 1.0, last modified 2-Jan-91.
Specification
Introduction
Global variables with system dependent values are stored here. They are the following strings, in various declaration styles. .ip "char Version[]"
Present Ingres version number in the format 9.9/99 (xxx.xxx/xx). The first 3 characters must map to a legal Ingres version number (e.g., 6.2). The remainder of the string is not defined. .ip "char Reldate[]"
Release date of present Version. .ip "char Env_ID[]"
Identifier for machine this implementation runs on, (e.g. AT&T, CMS, OSx). .ip "char Star_Version[]"
Present Ingres/STAR version number in the format 9.9/99 (xxx.xxx/xx). The first 3 characters must map to a legal Ingres version number (e.g., 6.2). The remainder of the string is not defined. Normally the same as Version. .ip "char Star_Env_ID[]"
Identifier for machine this implementation runs on, (e.g. AT&T, CMS, OSx). Normally the same as Env_ID. .ip "char *II_copyright"
The copyright notice must be included in the object code for all executable files shipped to customers.
The wording of the following copyright message is critical. Please don't play around with it without getting advice from the legal department.
The notice must be readable from a dump of the executable. The latter date in the copyright message should be the date of last major revision.
"Copyright (C) Ingres Corporation 1981, 1989 . All Rights Reserved. This is an unpublished work containing confidential and proprietary information of Ingres Corporation. Use, disclosure, reproduction, or transfer of this work without the express written consent of Ingres Corporation is prohibited. Use, duplication or disclosure by the Government is subject to restrictions as set forth in suSBaragraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause 252.227-7013."
Library
CL
Header File <gv.h>
The header file <gv.h> must be included before referencing the variables documented above.
Executable Interface
The following functions are provided.
GVver - Retrieves specified components of the version string
Function returns the specified components of the encoded version string.
Inputs:
| flags flags specifying requested components of the version. |
Outputs:
| vout pointer to an ING_VERSION structure to accept results. The structure is initialized on entry. |
Returns:
| OK function successfully completed. FAIL error. |
Definition:
STATUS GVver( flags, vout ) i4 flags; ING_VERSION* vout;
GVdecode - retrieves hardware and OS encoding
Returns the string equivalent of the hardware and OS encodings.
Inputs:
| enc encoding |
Outputs:
| str string representation |
Returns:
| OK command successful
FAIL command failed |
Definition:
STATUS GVdecode ( enc, str ) i4 enc; char *str;
GVcnf_init - Add initialization of configuration parameter MIB objects
Add initialization of configuration parameter MIB objects.
Inputs:
| None. |
Outputs:
| None. |
Returns:
| OK command completed successfully
FAIL command failed |
Definition:
STATUS GVcnf_init()
GVcnf_term - Remove initialized version MIB objects
Removes initialized version MIB objects.
Inputs:
| None. |
Outputs:
| None. |
Returns:
| None. |
Definition:
VOID GVcnf_term()
GVmo_init - Initialize version MIB objects
Add initialization of version MIB objects.
Inputs:
| None. |
Outputs:
| None. |
Returns:
| OK command completed successfully.
FAIL command failed. |
Definition:
STATUS GVmo_init()
GVmo_term - Free version MIB objects
Remove initialized version MIB objects.
Inputs:
| None. |
Outputs:
| None. |
Returns:
| None. |
Definition:
VOID GVmo_term()
GVgetverstr - Returns the version string
Returns the current version string.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetverstr( offset, objsize, object, luserbuf, userbuf) i4 offset; i4 object; PTR object; i4 luserbuf; char *userbuf;
GVgetenvstr - Returns the platform string
Returns the current platform string.
Inputs:
| offset unused |
| objsize unused |
| object unusued |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetenvstr( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf, char *userbuf;
GVgetversion - Returns the current build level
Returns the current build level.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetversion( offset, objsize, object, luserbuf, userbuf) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgetpatchlvl - Returns the patch level
Returns the current patch level.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetpatchlvl( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgettcpportaddr - Return the TCP port address
Returns the port address for the TCP protocol.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgettcpportaddr( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgetnetportaddr - Return the secondary net driver address
Returns the secondary net driver address.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetnetportaddr( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgetconformance - Return the SQL92 conformance
Returns the SQL92 conformance.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetconformance( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgetlanguage - Return the language setting
Returns the language setting.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetlanguage( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgetcharset - Returns the character set setting
Returns the character set string.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length fo buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetcharset( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgetinstance - return the instance identifier
Returns the instance identifier.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetinstance( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVgetsystempath - Returns the installation path
Returns the installation path to II_SYSTEM.
Inputs:
| offset unused |
| objsize unused |
| object unused |
| luserbuf length of buffer for return |
Outputs:
| userbuf buffer for return value |
Returns:
| OK command completed successfully |
Definition:
STATUS GVgetsystempath( offset, objsize, object, luserbuf, userbuf ) i4 offset; i4 objsize; PTR object; i4 luserbuf; char *userbuf;
GVosvers - Retrieves the OS version
Function grabs the OS version from various platforms.
Inputs:
| None. |
Outputs:
| OSVersionString string containg the OS version. |
Returns:
| TRUE version retrieved successfully
FALSE No platform-specific function, version wasn't returned |
Definition:
bool GVosvers( OSVersionString ) char *OSVersionString;
GVverifyOSversion - Verify Operating System version
Verifies Operating System version.
Inputs:
| versinfo minimum required OS version |
Outputs:
| None. |
Returns:
| OK the running system meets the minimum requirement |
| GV_BAD_PARAM size of GV_OSVERSIONINFO is incorrect or bad platform |
| FAIL system does not meet requirements |
Definition:
STATUS GVverifyOSversion ( versinfo ) GV_OSVERSIONINFO *versinfo;
GVshobj - Determines weather 'Global' prefix is required for shared objects
Retrieves major version of the OS and determines if 'Global' prefix is required to created shared objects for this platform.
Inputs:
| None. |
Outputs:
| shPrefix buffer for return value, should contain '\0' or 'Global' string |
Returns:
| None. |
Definition:
VOID GVshobj ( shPrefix ) char **shPrefix;
GVvista - Test if current OS is Windows Vista
Retrieves major version of the OS to determine if the machine is running Windows Vista.
Inputs:
| None. |
Outputs:
| None. |
Returns:
| 1 machine is running Windows Vista
0 machine is not running Windows Vista |
Definition:
int GVvista()
|
Ingres Compatability Library |
