File Name
Syntax
N_AppendStrList (VAL listItem:STRING, REF strList:LIST OF STRING)
Parameters
listItem - item to be appended to the end of the given string
list
strList - list of strings
Returns
None
Side Effects
None
Description
Appends the given item to the end of the given string list.
Dialog Forms Called
None
File Name
Syntax
N_CallFunction (VAL kbName:STRING, VAL funcName:STRING, VAL whdl:WINDOW):BOOLEAN
Parameters
kbName - name of KB file
funcName - function name
whdl - window handle (standard arg to all TPM system functions)
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Loads the given KB and then performs the given function contained in that kb.
Dialog Forms Called
None
File Name
Syntax
N_ChkUser (VAL dlgHdl:WINDOW, VAL userId:STRING, VAL descStr:STRING ):BOOLEAN
Parameters
dlgHdl - handle to dialog box
userId - user/group ID to validate
descStr - description of the user/group ID field (for error
reporting purposes)
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Checks the database to see if the given user ID is a valid user or group.
Dialog Forms Called
None
File Name
Syntax
N_ClearInqFlds (VAL dlgHdl:WINDOW, VAL clearFldList:LIST OF STRING, VAL setFldList:LIST OF STRING, VAL defVal:STRING ) IS
Parameters
dlgHdl - handle to dialog box
clearFldList - list of fields to be cleared
setFldList - list of fields to be re-initialized with defVal
defVal - default value to assign to fields in setFldList
Returns
None
Side Effects
None
Description
Assigns the given default value to the fields in setFldList, clears the fields in the clearFldList, and sets focus to the first field in the clearFldList.
Dialog Forms Called
None
File Name
Syntax
N_DeleteStrList (VAL listItem:STRING, REF strList:LIST OF STRING)
Parameters
listItem - item to be deleted from the given string list
strList - list of strings
Returns
None
Side Effects
None
Description
Deletes the given item from the given string list
Dialog Forms Called
None
File Name
Syntax
N_DisplayMsg (VAL wHdl:WINDOW, VAL iMsgType:INTEGER, VAL errNumStr:STRING, VAL msgStr:STRING, VAL listStrArgs:LIST OF STRING):INTEGER
Parameters
wHdl - handle to parent window
iMsgType - yype of message - Error, Warning, Info, or Trace
message
errNumStr - error Number string
msgStr - error message string
listStrArgs - list of string arguments to be used with msgStr
Returns
N_SUCCESS or return code from WinMessageBox()
Side Effects
None
Description
Determines whether to post an error message to be logged or display the message in a message box.
Dialog Forms Called
None
File Name
Syntax
N_GetBoolVal (VAL strFld:STRING):BOOLEAN
Parameters
strFld - string field containing TRUE, FALSE, or nothing
Returns
bBoolVal - Boolean value of the given string
Side Effects
None
Description
Returns the Boolean value represented in the given string variable.
Dialog Forms Called
None
File Name
Syntax
N_GetContactInfo (VAL wHdl:WINDOW, VAL people_id:INTEGER, REF curContact:BROWSEPEOPLELISTREC):BOOLEAN
Parameters
wHdl - handle to window
people_id - people ID for the contact person
curContact - people record of information for the contact person
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Get basic information about the given contact person who is to be used as the caller for problem tickets.
Dialog Forms Called
None
File Name
Syntax
N_InitListBox (VAL hDlg:WINDOW, VAL listBoxName:STRING, VAL listVals:LIST OF STRING, VAL prevVal:STRING, VAL defVal:STRING) IS
Parameters
hDlg - Handle to dialog box
listBoxName - name of the list box
ListVals - list of values to be inserted into the dialog box
prevVal - Previously selected value (if any)
defVal - Default value to be displayed (if no previous value)
Returns
None
Side Effects
None
Description
Initializes the given list box with the given list of values. Displays the appropriate initial value.
Dialog Forms Called
None
File Name
Syntax
N_LoadIntList (VAL bAppend:BOOLEAN, VAL listDesc:STRING, VAL sqlSelectStr:STRING, REF intList:LIST OF INTEGER ):BOOLEAN
Parameters
bAppend - append (or insert) the retrieved item into the list
listDesc - description of the list (error reporting purposes)
sqlSelectStr - SQL select string for retrieving the items
from the database
strList - final integer List of retrieved items
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Loads a list of integer objects from the database.
Dialog Forms Called
None
File Name
Syntax
N_LoadStrList (VAL bAppend:BOOLEAN, VAL listDesc:STRING, VAL sqlSelectStr:STRING, REF strList:LIST OF STRING ):BOOLEAN
Parameters
bAppend - Append (or insert) the retrieved item into the list
listDesc - Description of the list (error reporting purposes)
sqlSelectStr - SQL select string for retrieving the items
from the database
strList - final string list of retrieved items
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Loads a list of string objects from the database.
Dialog Forms Called
None
File Name
Syntax
N_LogToFile (VAL whdl:WINDOW, VAL iLogLvl:INTEGER, VAL message:STRING):BOOLEAN
Parameters
wHdl - handle to parent window
iLogLvl - level of log message - Error, Warning, Info, or
Trace message
message - message to be logged to the error log file
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Writes the given error message to the log file specified on the Error tab of the Network System Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
N_MakeTimeStamp (VAL tTime:TIME, VAL dDate:DATE):INTEGER
Parameters
tTime - time value to be converted
dDate - date value to be converted
Returns iTimeStamp calculated from tTime and dDate
Returns
None
Side Effects
Normalizes the timestamp to database time using SAI_TimestampPcToDb () and then normalizes the timestamp to GMT time using SAI_TimestampDbToGMT().
Description
Generates an integer time stamp given the time and date. The time stamp is the number of seconds since Jan 1, 1990.
Dialog Forms Called
None
File Name
Syntax
N_MsgBox (VAL wHdl:WINDOW, VAL iMsgType:INTEGER, VAL msgStr:STRING, VAL listStrArgs:LIST OF STRING):INTEGER
Parameters
wHdl - handle to parent window
iMsgType - type of message - Error, Warning, Info, or Trace
message
msgStr - error message string
listStrArgs - list of string arguments to be used with msgStr
Returns
Integer
Side Effects
None
Description
Displays an error message in a message box. It is called directly from a TNM dialog box or indirectly by the N_DisplayMsg() function.
Dialog Forms Called
None
File Name
Syntax
N_MsgLog (VAL iMsgType:INTEGER, VAL errNumStr:STRING, VAL msgStr:STRING, VAL listStrArgs:LIST OF STRING):INTEGER
Parameters
iMsgType - type of message - Error, Warning, Info, or Trace
message
errNumStr - error number string
msgStr - error message string
listStrArgs - list of string arguments to be used with msgStr
Returns
N_SUCCESS
Side Effects
Assigns values to TNM global variable, g_NLogData. References application server global variable, g_HdlDispatch.
Description
Posts a message to the application server to be logged. It is called directly from the application server or indirectly by the N_DisplayMsg() function.
Dialog Forms Called
None
File Name
Syntax
N_MsgPost (VAL wHdl:WINDOW, VAL iMsgType:INTEGER, VAL errNumStr:STRING, VAL msgStr:STRING, VAL listStrArgs:LIST OF STRING):INTEGER
Parameters
wHdl - handle to parent window
iMsgType - type of message - Error, Warning, Info, or Trace
message
errNumStr - error number string
msgStr - error message string
listStrArgs - list of string arguments to be used with msgStr
Returns
N_SUCCESS
Side Effects
None
Description
Posts a message to the given window to be logged.
Dialog Forms Called
None
File Name
Syntax
N_NetConnect (VAL whdl:WINDOW, VAL serviceName:STRING, VAL nmpHostName:STRING, REF nmpHostRec:NETCONNECTION):INTEGER
Parameters
whdl - handle to window initiating the call
serviceName - name of service to which to connect
nmpHostName - Name of nmp host where the service resides
nmpHostRec - information about the NMP host
Returns
N_NET_SUCCESS or error from ASE function, NetConnect
Side Effects
None
Description
Establishes a network connection to the given service on the given NMP host.
Dialog Forms Called
None
File Name
Syntax
N_NetGetPortFromService (VAL serviceName:STRING):INTEGER
Parameters
serviceName - network service for which to perform port search for
Returns
port # for given network service OR 0 if service not found
Side Effects
Calls the TSD script C call-out routine, do_NETGETPORTFROMSERVICE. Needs to change the name of the dll, kmln510, whenever TSD script changes it.
Description
Deletes record(s) from the given database table for the given select string (performs an SQLDelete).
Dialog Forms Called
None
File Name
Syntax
N_ReqValExists (VAL dlgHdl:WINDOW, VAL fldName:STRING, VAL fldVal:STRING, VAL fldLabel:STRING ):BOOLEAN
Parameters
dlgHdl - handle to dialog box calling this function
fldName - name of required field being checked
fldVal - value in the field being checked
fldLabel - label of the field being checked
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Checks the given required dialog box entry box to see if data has been entered. If the box has no value entered, then an error message is displayed.
Dialog Forms Called
None
File Name
Syntax
N_SendNotification (VAL rcvr_id:STRING, VAL bIsGroup:BOOLEAN, VAL sender_id:STRING, VAL ntfyTitle:STRING, VAL ntfyText:STRING, VAL problem_id:STRING)
Parameters
rcvr_id - ID of the user/group to recieve notification
bIsGroup - indicates if the rcvr_id is a group ID or not
sender_id - ID of user sending the notification
ntfyTitle - title of notification
ntfyText - actual text of the notification
problem_id - ID of associated problem (if any)
Returns
None
Side Effects
None
Description
Sends a notification to the specified user (or group).
Dialog Forms Called
None
File Name
Syntax
N_SetButtons (VAL dlgHdl:WINDOW, VAL strList1Control:STRING, VAL strList2Control:STRING, VAL listButtons:LIST OF STRING)
Parameters
dlgHdl - handle to dialog box calling this function
strList1Control - name of list control 1
strList2Control - name of list control 2 (if any)
listButtons - list of buttons to enable/disable
Returns
None
Side Effects
None
Description
Checks the number of items in the given list control(s) and enables/disables the buttons in the given list accordingly.
Dialog Forms Called
None
File Name
Syntax
N_SetViewMode (VAL dlgHdl:WINDOW, VAL listControls:LIST OF STRING, VAL okButton:STRING, VAL cancelButton:STRING)
Parameters
dlgHdl - handle to dialog box
listControls - list of controls to disable
okButton - name of the 'OK' button control - changes
button label to 'CLOSE'
cancelButton - name of the 'CANCEL' button control -
hides this button
Returns
None
Side Effects
None
Description
Sets the given dialog box to view mode.
Dialog Forms Called
None
File Name
Syntax
N_SQLDelete (VAL whdl:WINDOW, VAL dbTable:STRING, VAL dbItem:STRING, VAL sqlSelectStr:STRING ):BOOLEAN
Parameters
whdl - window handle
dbTable - name of database table
dbItem - database item to be deleted
sqlSelectStr - select string
Returns
bOk - Success flag (TRUE/FALSE)
Side Effects
None
Description
Deletes record(s) from the given database table for the given select string (performs an SQLDelete).
Dialog Forms Called
None