Apollo API Listing > sx

VB Declaration

Declare Function sx_SysProp Lib "Apollo9.dll"

(ByVal uiSysItem As Integer,

ByVal vpData As Any)

As Long

C Declaration

LONG FAR PASCAL sx_SysProp

(USHORT uiSysItem,

VOIDP vpData);

Description

Sets or retrieves SDE system information. For calls that return pointer-based information, pass a pre-declared Pointer type for vpData to be filled; Otherwise, pass nil for this parameter. For calls that do not return a pointer-based value, the value is returned as a Longint.

Parameters

uiSysItem: One of the predefined constant values listed below, indicating the type of information to be set or retrieved. All supported constants are listed in the SDE??.BAS file.

vpData: General purpose pointer. This pointer is used by some properties to pass in a workarea number or even a pointer to a structure to be filled.

Constant Value	vpData Value	Return Value
SDE_SP_GETADDQUERY SDE_SP_SETADDQUERY		Get/set the AddQueryFlag
SDE_SP_GETCHRCOLLATE SDE_SP_SETCHRCOLLATE	Bool Array of Char[0..255]	Get/set the collation sequence for Windows tables.
SDE_SP_GETDELETED		Get Deleted value
SDE_SP_GETDESCENDING	Order Number (Integer)	Current Descending value (Bool)
SDE_SP_GETDISABLEAUTO SDE_SP_SETDISABLEAUTO	NULL New AutoOpen setting (Bool)	Current AutoOpen setting (Bool)
SDE_SP_GETDRIVER	Workarea Number (Integer)	Get the active driver: 1 = SDENTX 2 = SDEFOX 3 = SDENSX 4 = SDENSX_DBT
SDE_SP_GETDUDENCOLLATE SDE_SP_SETDUDENCOLLATE	NULL New Duden Collation (Bool)	Get/set the German Duden Collation setting (Bool)
SDE_SP_GETEMPTY	Order Number (Integer)	Current Empty Value (Bool)
SDE_SP_GETEXACT SDE_SP_SETEXACT	NULL New Exact Value	Current Exact Value (Bool)
SDE_SP_GETINDEXCOUNT	NULL	Number of index tags in the current workarea
SDE_SP_GETLANGUAGECOLLATE	NULL	Get/set language, according to collation done
SDE_SP_GETLGTRCOLLATE SDE_SP_SETLGTRCOLLATE	NULL	Get/set the ligatures collation dimmension
SDE_SP_GETLIMITCASECONV SDE_SP_SETLIMITCASECONV	NULL New Case-Conversion setting Boo(Bool)	Current Case-Conversion setting (Bool). Limit case conv to A-Z, a-z if TRUE.
SDE_SP_GETOBUFFER SDE_SP_SETOBUFFER	NULL New Setting (Bool)	Get/set Optimistic Buffer Setting (Bool)
SDE_SP_GETOEMCOLLATE SDE_SP_SETOEMCOLLATE	NULL Array of Char[0..255]	Get/set the collation sequence for OEM tables.
SDE_SP_GETQUERYRELAXFLAG SDE_SP_SETQUERYRELAXFLAG	NULL	Get flag that dictates rules of query
SDE_SP_GETSECURITY SDE_SP_SETSECURITY	NULL	Get Server Security
SDE_SP_GETSOFTSEEK SDE_SP_SETSOFTSEEK	NULL New SoftSeek Value (Bool)	Current SoftSeek Value (Bool)
SDE_SP_GETSPECIALCOLLATE SDE_SP_SETSPECIALCOLLATE	NULL Bool	Get/set the international collation such as DUDEN collate flag
SDE_SP_GETSTRINGTYPE SDE_SP_SETSTRINGTYPE	NULL	Get/set the stringtype flag
SDE_SP_GETUSECONDITIONAL SDE_SP_SETUSECONDITIONAL	NULL New UseConditional Value (Bool)	Get/set UseConditional Value (Bool)
SDE_SP_PUTOBUFFER	NULL	Cause immediate flush of optimistic buffer
SDE_SP_SETDBTNSX	Bool	Allows DBF/DBT to use NSX index driver
SDE_SP_SETDEFAPPEND	Bool	Set default behavior for ordering of non-unique keys like FOX/Clipper.
SDE_SP_SETSTRDEFDEC	Integer	Set the default decimals for the STR() function, if 3rd parameter is absent and field length is zero.
SDE_SP_SETSTRDEFLEN	Integer	Set the default length for STR() function, if 2nd parameter is absent and field length zero
SDE_SP_SETWRITEBLOBHDR	Bool	Set the bWriteBlobHdr

Return Value

Varies depending on the type of data being requested. For example, logical return values are returned as 0 for False and any non-zero value for True. If the information requested is being returned as a pointer to a static buffer, the Longint return value will contain this pointer address.

VB Example

' Get SoftSeek value

lRetVal = sx_SysProp( SDE_SP_GETSOFTSEEK, 0 )

' Get Exact setting

lRetVal = sx_SysProp( SDE_SP_GETEXACT, 0 )

' Get Driver value for current workarea

lRetVal = sx_SysProp( SDE_SP_GETDRIVER, 0 )

' Get Driver value for workarea 1

lRetVal = sx_SysProp( SDE_SP_GETDRIVER, 1 )

' Set Optimistic Buffering OFF – Must be done BEFORE opening table

lRetVal = sx_SysProp( SDE_SP_SETOBUFFER, 0 )

' Both dBase and Clipper UPPER() and LOWER() case conversion functions

' limit the characters eligible for case conversion. With UPPER(), only

' characters a-z are converted to upper case. With LOWER(), only

' characters A-Z are converted. Characters with diacritical marks ARE NOT

' CONVERTED when this switch is TRUE if sx_SetTranslate is also set to TRUE.

' To limit case conversion using this switch, set sx_SetTranslate to TRUE

' and set the sx_SysProp value on as well.

sx_SetTranslate( True )

lRetVal = sx_SysProp( SDE_SP_SETLIMITCASECONV, 1 )

C Example

//These are some examples of how to call sx_SysProp with a few constants

//Get softseek value

lRetVal = sx_SysProp( SDE_SP_GETSOFTSEEK, (VOIDP)NULL );

//Get Exact

lRetVal = sx_SysProp( SDE_SP_GETEXACT, (VOIDP)NULL);

//Get Driver Constant for current workarea

lRetVal = sx_SysProp( SDE_SP_GETDRIVER, (VOIDP)NULL);

//Get Driver Constant for workarea 1

lRetVal = sx_SysProp( SDE_SP_GETDRIVER, (VOIDP)1);

//Set Optimistic Buffering OFF - Must be done BEFORE opening table

sx_SysProp( SDE_SP_SETOBUFFER, (VOIDP)0);

// Both dBase and Clipper UPPER() and LOWER() case conversion functions

// limit the characters eligible for case conversion. With UPPER(), only

// characters a-z are converted to upper case. With LOWER(), only

// characters A-Z are converted. Characters with diacritical marks ARE NOT

// CONVERTED when this switch is TRUE if sx_SetTranslate is also set to TRUE.

// To limit case conversion using this switch, set sx_SetTranslate to TRUE

// and set the sx_SysProp value on as well.

sx_SetTranslate( TRUE );

sx_SysProp( SDE_SP_SETLIMITCASECONV, (VOIDP)1 );