Routines for c_svcs.kb


AddToWindowList

File Name

c_svcs.kb

Syntax

AddToWindowList( VAL win: WINDOW)

Parameters

win - the handle of the dialog box to add to the global window list

Returns

Nothing

Side Effects

None

Description

This procedure adds a window handle to the global window list.

Dialog Forms Called

None


BuildWhereClause

File Name

c_svcs.kb

Syntax

BuildWhereClause(VAL subExprs: LIST OF STRING,VAL separator: STRING): STRING

Parameters

subExprs - list of expressions in the WHERE clause

separator - separator for expressions in the WHERE clause

Returns

list of expressions separated by separator

Side Effects

None

Description

This function takes the expressions in subExprs and concatenates them together with the separator.

Dialog Forms Called

None


CheckAuthority

File Name

c_svcs.kb

Syntax

CheckAuthority ( VAL formWindow: Window, VAL formFile: String, VAL formName: String )

Parameters

formWindow - window which contains the dialog box form

formFile - dialog box file name

formName - dialog box form name

Returns

Nothing

Side Effects

None

Description

This function searches the existing list of defined button security rights against the form file and name passed in. If a button is found that has a right, and the right is not part of the security mask parameter, then that button on the dialog box is disabled.

Dialog Forms Called

None


CommonDefaultSeverity

File Name

c_svcs.kb

Syntax

integerRet:= DefaultSeverity;

Parameters

None

Returns

Integer - numeric severity code

Side Effects

None

Description

This function returns the value of the user-configured default severity code.

Dialog Forms Called

None


GetLogMsgPrefix

File Name

c_svcs.kb

Syntax

GetLogMsgPrefix (VAL logLvl:INTEGER, VAL errCode:STRING):STRING

Parameters

logLvl - log level (ie, Alert, Info, etc...)

errCode - error code

Returns

prefix - log message prefix

Side Effects

None

Description

Creates a log message prefix containing the log level, an error code, and the date/time.

Dialog Forms Called

None


GetSystemAction

File Name

c_svcs.kb

Syntax

action:= GetSystemAction ( action_id, security_mask );

Parameters

system_action_id - system action ID to load action and verify security rights

rightMask - security mask specifying the exact rights the current user has in the system

Returns

Either the action associated with this action ID

if the user has security rights, or $Unknown if

the user does not have the right to run this action.

Side Effects

None

Description

This function verifies that the current user can execute the system action associated with the action ID passed in. If the user has the right to execute the action, then the action is returned. Otherwise, $Unknown is returned.

Dialog Forms Called

None


HasRight

File Name

c_svcs.kb

Syntax

HasRight(VAL right: INTEGER, VAL security_mask: INTEGER): BOOLEAN

Parameters

right - the ID of the right

security_mask - an integer number of the user or group's rights

Returns

TRUE or FALSE

Side Effects

None

Description

This function checks if the security_mask has rights. If so, TRUE is returned. Otherwise, FALSE is returned.

Dialog Forms Called

None


InitRemTrans

File Name

c_svcs.kb

Syntax

None

Parameters

None

Returns

None

Side Effects

None

Description

Initialize a remote transfer.

Dialog Forms Called

None


ListToIntegerList

File Name

c_svcs.kb

Syntax

ListToIntegerList(REF objList: LIST OF INTEGER, VAL objField: STRING,VAL noNeg: BOOLEAN):STRING

Parameters

objList - list of integers

objField - database field in which the objects reside

noNeg - indicates an "in" (TRUE) or "not in" clause (FALSE)

Returns

A string of the objects in an 'in' clause

Side Effects

None

Description

This function takes the objList and puts it into an "in" clause. If the number of items in objList exceeds 254, then the multiple "in" clauses are created and appended together.

Dialog Forms Called

None


ListToStringList

File Name

c_svcs.kb

Syntax

ListToStringList(REF objList: LIST OF STRING, VAL objField: STRING,VAL noNeg: BOOLEAN):STRING

Parameters

objList - list of strings

objField - database field that the objects are in

noNeg - indicates an "in" (TRUE) or "not in" clause (FALSE)

Returns

a string of the objects in an "in" clause

Side Effects

None

Description

This function takes the objList and puts it into an "in" clause. If the number of items in objList exceeds 254, then the multiple "in" clauses are created and appended together.

Dialog Forms Called

None


LoadSeverityList

File Name

c_svcs.kb

Syntax

PROCEDURE LoadSeverityList

Parameters

Returns

None

Side Effects

None

Description

This procedure selects the severity level description.

Dialog Forms Called

None


ParseSiteQualifiedID

File Name

c_svcs.kb

Syntax

ParseSiteQualifiedID ( VAL parsee: STRING, REF preSeparator: STRING, REF postSeparator: STRING )

Parameters

parsee - string to parse

preSeparator - prefix

postSeparator - suffix

Returns

None

Side Effects

None

Description

Added for use with usercach.kb from p_svcs. Parses the site ID with the user ID for DDM.

Dialog Forms Called

None


PerformAction

File Name

c_svcs.kb

Syntax

PerformAction(action)

Parameters

action - String

Returns

The returned integer number of the action performed

Side Effects

None

Description

Given an action, this function determines how to execute it and then executes it.

Dialog Forms Called

None


RemoveFmWindowList

File Name

c_svcs.kb

Syntax

RemoveFmWindowList(VAL win: Window))

Parameters

win - the window handle

Returns

Nothing

Side Effects

None

Description

This procedure removes the window handle from the global window list.

Dialog Forms Called

None


ResetLogFileName

File Name

c_svcs.kb

Syntax

ResetLogFileName (VAL wHdl:WINDOW, VAL filePrefix:STRING, VAL opSys:STRING, VAL fileErrMsg:STRING, REF fileName:STRING ) IS

Parameters

wHdl - handle to parent window

filePrefix - prefix for the log file

opSys - operating system

fileErrMsg - error message if file has problems

fileName - name of log file

Returns

None

Side Effects

None

Description

Creates a log file name of the form xxYYMMDD.log where xx filePrefix, YY is the year, MM is the month, and DD is the day.

Dialog Forms Called

None


RunningOnTheWeb

File Name

c_svcs.kb

Syntax

RunningOnTheWeb: BOOLEAN

Parameters

Nothing

Returns

TRUE - on the web, FALSE - Windows, UNIX, O/S 2

Side Effects

None

Description

Determines if the application is running on the web.

Dialog Forms Called

None


SeverityName

File Name

c_svcs.kb

Syntax

FUNCTION SeverityName(VAL severity: INTEGER): STRING;

Parameters

Severity - the severity level for which one wants the name

Returns

Severity description corresponding to the ID passed in

Side Effects

None

Description

This function returns the severity description corresponding to the severity level paramater.

Dialog Forms Called

None


SeverityNumber

File Name

c_svcs.kb

Syntax

FUNCTION SeverityNumber(VAL severityName: STRING): INTEGER;

Parameters

severityName - severity description

Returns

Severity Level corresponding to the severity description passed in

Side Effects

None

Description

This function returns the severity level corresponding to the severity description parameter.

Dialog Forms Called

None


StringEqual

File Name

c_svcs.kb

Syntax

StringEqual(REF s1: String, REF s2: String): BOOLEAN

Parameters

s1 - first string

s2 - second string

Returns

Boolean - TRUE or FALSE indicating if both strings are equal

Side Effects

None

Description

This function checks if s1 and s2 are equal.

Dialog Forms Called

None