Tivoli Service Desk 6.0 Developer's Toolkit Script Language Reference

TSD Script Constants

Return to Main Page


Window Styles

The following style flags are used with the WinCreate, WinCreateScrollWindow, and WinEditField statements, unless otherwise noted. They determine the elements that should be added to the window that you create. The elements can be combined using the BitOr operator.

Tip: For more information see the TSD Script Messages page.

Size and Position Elements

Style Flag Description
$WinAutoPos The operating system determines the best position for the window, ignoring the xLoc and yLoc parameters in the WinCreate or WinCreateScroll Window statements.
$WinAutoSize The operating system determines the best size for the window, ignoring the xLen and yLen parameters in WinCreate or WinCreateScroll Window.
$WinMinimized Allows windows to be created in iconic (minimized) state.

Border Styles

Style Flag Description
$WinBorder The window is created with a border similar to a dialog box. Several styles require a border. This style is mutually exclusive with $WinField.
$WinField The window is created with a 1-pixel border (like text boxes in dialog boxes). This style is mutually exclusive with $WinBorder.
$WinResize The window is created with a resize border. This style requires that the $WinBorder style be present. If $WinTitle is present, a maximize button is automatically added to the window.

Window Elements

Style Flag Description
$WinHScroll The window is created with a horizontal scroll bar. The window must be capable of processing the scroll bar messages for the scroll bar to function. This cannot be used with WinEditField.
$WinIconBar The window is created with a toolbar. The toolbar is added below the title bar and menu bar (if present) and does not display when empty. This cannot be used with WinEditField.

The toolbar can be loaded with the WinSetIconBar statement. $WinBorder is required.

$WinMenu The window is created with a menu bar. This cannot be used with WinEditField. An empty menu bar does not display. The menu selections can be set using the $WinSetMenuBar statement. $WinBorder must be present.
$WinMinMax Minimize and maximize buttons are added to the upper right corner of the window. A default, minimized icon is created for the window. The icon can be altered with the $MsgSetIcon message. $WinBorder is required. This cannot be used with WinEditField.

In Windows, if you do not specify $WinMinMax, your title bar does not have a minimize or maximize button.

In OS/2 if you do not specify $WinMinMax, your title bar contains a gray zone where these buttons would otherwise be.

$WinStatus The window is created with a status bar. The application draws the contents of the status bar in response to the $MsgPaintStatus message. This cannot be used with WinEditField.
$WinSysMenu The window is created with a system menu. $WinBorder must be present. This cannot be used with WinEditField.
$WinTitle The window is created with a title bar. If this style is not present, no title appears, even if a title is specified as one of the parameters. A title bar allows the window to move.
$WinVScroll The window is created with a vertical scroll bar. The window must be capable of processing the scroll bar messages for the scroll bar to function. This cannot be used with WinEditField.

Other Window Elements

Style Flag Description
$WinAutoScroll Scrolls the window vertically to keep the last line in the window visible. If you use this flag to create a scroll window and you repeatedly call WinWriteLN to log information to the window, the window automatically scrolls to keep data that was written below the client area visible as the last line in the display.

Note: This flag can be used with the $WinCreateScrollWindow, but not with $WinCreate.

$WinDefaultStyle The window is created with the default window style. This is the combination of $WinBorder, $WinResize, $WinTitle, and $WinSysMenu.
$WinInvisible The window is created to be hidden. $MsgShow must be sent to make the window visible.
$WinModal The window created by the WinEditField statement is enabled when it is created. However, its parent window and all of the other child windows of that parent window are disabled.

This style is used only with the WinEditField statement.

$WinNone The window is created with none of the listed attributes.
$WinTaskList The window title is listed in the system task list. The user can activate the window from the task list. This style should generally be used for the application's main window.

In Windows, this style is ignored, and any windows parented by the desktop appear in the system switch list.

Text Colors and Opaque versus Transparent

These constants are used with the WinSetColor statement to set window text to the specified color.
The constants $WinOpaque and $WinTransparent can each be combined with one of the other color constants using the BitOr operator.

Tip: The $WinDefaultColor and $WinDefaultStyle constants are used if you do not specify any other colors and styles.

Opaque versus Transparent Text

Style Flag Description
$WinOpaque The text is opaque. This is not available in OS/2.
$WinTransparent The text is transparent.

Text Colors

Style Flag Description
$WinDefaultColor The text is the default color, as determined by the operating system.
If you specify the foreground color as $WinDefaultColor, the color specified in $SysClrWindowText is used.

If you specify the background color as $WinDefaultColor, the color specified in $SysClrWindow is used.

$WinBlack Black text
$WinBlue Blue text
$WinBrown Brown text
$WinCyan Cyan text
$WinDarkGray Dark gray text
$WinGreen Green text
$WinLightBlue Light blue text
$WinLightCyan Light cyan text
$WinLightGray Light gray text
$WinLightGreen Light green text
$WinLightMagenta Light magenta text
$WinLightRed Light red text
$WinMagenta Magenta text
$WinRed Red text
$WinWhite White text
$WinYellow Yellow text

System-defined Window Colors

These constants represent the colors users set as preferences for the operating system in which they work. These constants cannot be combined. (If they are combined, an invalid value is generated).

Style Flag Description
$SysClrActiveBorder The active window border color
$SysClrActiveTitle The active window title bar color
$SysClrActiveTitleText The active window title bar text color
$SysClrActiveTitleTextBgnd The active window title bar text background color
$SysClrAppWorkspace The client area color
$SysClrBackground The window background color
$SysClrButtonDark The three-dimensional button dark highlight
$SysClrButtonDefault The default button color as determined by the operating system
$SysClrButtonLight The three-dimensional button light highlight
$SysClrButtonMiddle The button background color as determined by the operating system
$SysClrDialogBackground The dialog box background color
$SysClrEntryField The text box color
$SysClrFieldBackground The text box background color
$SysClrHelpBackground The help text background color
$SysClrHelpHilite The help highlights (hot spots or links) color
$SysClrHelpText The help text color
$SysClrHiliteBackground The help highlights (hot spots or links) background color
$SysClrHiliteForeground The help highlights (hot spots or links) foreground color
$SysClrIconText The icon text color
$SysClrInactiveBorder The inactive window border color
$SysClrInactiveTitle The inactive window title bar color
$SysClrInactiveTitleText The inactive window title text color
$SysClrInactiveTitleTextBgnd The inactive window title text background color
$SysClrMenu The menu bar color
$SysClrMenuDisabledText The disabled text color
$SysClrMenuHilite The selected menu item color
$SysClrMenuHiliteBgnd The selected menu item background color
$SysClrMenuText The menu text color
$SysClrOutputText The output text color
$SysClrPageBackground The page background color
$SysClrScrollBar The scroll bar color
$SysClrShadow The shadow color. This is not available in Windows.
$SysClrShadowHiliteBgnd The three-dimensional shadow background color. This is not available in Windows.
$SysClrShadowHiliteFgnd The three-dimensional shadow foreground color. This is not available in Windows.
$SysClrShadowText The shadow text color
$SysClrTitleBottom The system menu button color
$SysClrTitleText The title bar text color
$SysClrWindow The window background color
$SysClrWindowFrame The window frame color
$SysClrWindowStaticText The window static text color
$SysClrWindowText The window text color

System Menu Close Item

You can enable or disable the Close item on a window's system menu. Use the $SysMenuCloseItem constant with the WinMenuEnableItem statement as follows:

(*This enables the Close item *)
WinMenuEnableItem(myWindow,
$SysMenuCloseItem, TRUE);
(*This disables the Close item: *)
WinMenuEnableItem(myWindow,
$SysMenuCloseItem, FALSE);

Key Codes

These constants represent the values that are passed to the system when a user presses the key indicated in the table below. These constants cannot be combined. If they are combined, an invalid value is generated.

The following table shows $MsgChar parameters and corresponding Alt + letter keys pressed by the user.

Alt + Letter Key Codes

The following table shows $MsgChar parameters and corresponding Alt + letter keys pressed by the user.

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the ALT key and the...
$KeyAltA A key
$KeyAltB B key
$KeyAltBS Backspace key
$KeyAltC C key
$KeyAltD D key
$KeyAltE E key
$KeyAltF F key
$KeyAltG G key
$KeyAltH H key
$KeyAltI I key
$KeyAltJ J key
$KeyAltK K key
$KeyAltL L key
$KeyAltM M key
$KeyAltN N key
$KeyAltO O key
$KeyAltP P key
$KeyAltQ Q key
$KeyAltR R key
$KeyAltS S key
$KeyAltT T key
$KeyAltU U key
$KeyAltV V key
$KeyAltW W key
$KeyAltX X key
$KeyAltY Y key
$KeyAltZ Z key

Alt + Function Key Codes

(The following table shows $MsgChar parameters and corresponding Alt + function keys pressed by the user. )

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the Alt key and the...
$KeyAltFn1 F1 key
$KeyAltFn2 F2 key
$KeyAltFn3 F3 key
$KeyAltFn4 F4 key
$KeyAltFn5 F5 key
$KeyAltFn6 F6 key
$KeyAltFn7 F7 key
$KeyAltFn8 F8 key
$KeyAltFn9 F9 key
$KeyAltFn10 F10 key

Alt+Arrow Key Codes

The following table shows $MsgChar parameters and corresponding Alt + arrow keys pressed by the user.

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the Alt key and the...
$KeyAltLeftArrow Left Arrow key
$KeyAltRightArrow Right Arrow key

Control + Key Codes

The following table shows $MsgChar parameters and corresponding Ctrl+ special keys pressed by the user.

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the Ctrl key and the...
$KeyControlDelete Delete key
$KeyControlDownArrow Down Arrow key
$KeyControlEnd End key
$KeyControlFn1 F1 key
$KeyControlFn2 F2 key
$KeyControlFn3 F3 key
$KeyControlFn4 F4 key
$KeyControlFn5 F5 key
$KeyControlFn6 F6 key
$KeyControlFn7 F7 key
$KeyControlFn8 F8 key
$KeyControlFn9 F9 key
$KeyControlFn10 F10 key
$KeyControlFn11 F11 key
$KeyControlFn12 F12 key
$KeyControlHome Home key
$KeyControlInsert Insert key
$KeyControlPageDown Page Down key
$KeyControlPageUp Page Up key
$KeyControlRightArrow Right Arrow key
$KeyControlLeftArrow Left Arrow key
$KeyControlUpArrow Up Arrow key

Function Key Codes

The following table shows $MsgChar parameters and corresponding function keys pressed by the user.

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the...
$KeyFn1 F1 key
$KeyFn2 F2 key
$KeyFn3 F3 key
$KeyFn4 F4 key
$KeyFn5 F5 key
$KeyFn6 F6 key
$KeyFn7 F7 key
$KeyFn8 F8 key
$KeyFn9 F9 key
$KeyFn10 F10 key
$KeyFn11 F11 key
$KeyFn12 F12 key

Shift + Key Codes

The following table shows $MsgChar parameters and corresponding Shift+ keys pressed by the user.

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the Shift key and the...
$KeyShiftDelete Delete key
$KeyShiftDownArrow Down Arrow key
$KeyShiftEnd End key
$KeyShiftHome Home key
$KeyShiftInsert Insert key
$KeyShiftLeftArrow Left Arrow key
$KeyShiftPageDown Page Down key
$KeyShiftPageUp Page Up key
$KeyShiftTab Tab key
$KeyShiftRightArrow Right Arrow key
$KeyShiftUpArrow Up Arrow key

Shift and the Function Key Codes

The following table shows $MsgChar parameters and corresponding Shift + function keys pressed by the user.

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the Shift key and the...
$KeyShiftFn1 F1 key
$KeyShiftFn2 F2 key
$KeyShiftFn3 F3 key
$KeyShiftFn4 F4 key
$KeyShiftFn5 F5 key
$KeyShiftFn6 F6 key
$KeyShiftFn7 F7 key
$KeyShiftFn8 F8 key
$KeyShiftFn9 F9 key
$KeyShiftFn10 F10 key
$KeyShiftFn11 F11 key
$KeyShiftFn12 F12 key

Key Codes for Scroll Bars

The following table shows $MsgChar parameters and the corresponding location in the scroll bar where the user clicked the mouse.

When this $MsgChar parameter is passed to an event handler... it indicates that the user clicked the mouse...
$KeyScrollPageUp in the empty area of a vertical scroll bar above the scroll box.
$KeyScrollPageDown in the empty area of a vertical scroll bar below the scroll box.
$KeyScrollPageLeft in the empty area of a vertical scroll bar to the left of the scroll box.
$KeyScrollPageRight in the empty area of a vertical scroll bar to the right of the scroll box.
$KeyScrollLineUp on the up arrow of a vertical scroll bar.
$KeyScrollLineDown on the down arrow of a vertical scroll bar.
$KeyScrollLineLeft on the left arrow of a horizontal scroll bar.
$KeyScrollLineRight on the right arrow of a horizontal scroll bar.

Miscellaneous Key Codes

The following table shows $MsgChar parameters and corresponding miscellaneous keys pressed by the user.

When this $MsgChar parameter is passed to an event handler... it indicates that the user pressed the...
$KeyBackSpace Backspace key
$KeyHome Home key
$KeyInsert Insert key
$KeyLeftArrow Left Arrow key
$KeyPageDown Page Down key
$KeyPageUp Page Up key
$KeyReturn Return key
$KeyRightArrow Right Arrow key
$KeyUpArrow Up Arrow key
$KeyDownArrow Down Arrow key
$KeyCRCarriage Return key
$KeyDelete Delete key
$KeyEndkey End key
$KeyEscape Escape key

Image Styles

Constants define image styles. Multiple styles can be combined using the BitOr statement. An example of combined image styles is the combination of a title bar, a scroll bar, and a clipped image. Image styles are used with the WinCreateImage statement. The Windows default is $ImgScale. The OS/2 default is $ImgBorder.

The following table lists constants and the resulting image styles.

Constant Image Style
$ImgBorder Puts a border around the image
$ImgClip Clips the image to the window rectangle. Does not scale the image
$ImgScale Scales the image to fit in the window
$ImgScroll Scrolls the image. Does not scale the image to fit in the window
$ImgTitle Puts a title bar on the window that contains the image

Mouse Pointers

The following table shows available mouse pointers. They are sent with the WinSetPointer statement. The default pointer constant is $MouseDefaultPtr. BitOr statements cannot be used with mouse pointers.

This mouse pointer... displays the...
$MouseMaxPointer maximize pointer.
$MouseCrossPtr cross hair pointer.
$MouseDefaultPtr default pointer.
$MouseDLArrowPtr down-angled, left arrow pointer.
$MouseDLResizePtr down-angled left resize pointer.
$MouseDnResizePtr down-angled, resize pointer.
$MouseDRArrowPtr down-angled right arrow pointer.
$MouseDRResizePtr down-angled, right resize pointer.
$MouseHandPtr hand pointer.
$MouseHourglassPtr hour glass pointer.
$MouseIBeamPtr I-Beam pointer.
$MouseLTResizePtr left resize pointer.
$MouseRTResizePtr right resize pointer.
$MouseULArrowPtr up-angled, left arrow pointer.
$MouseULResizePtr up-angled, left resize pointer.
$MouseUPResizePtr up-angled, resize pointer.
$MouseURArrowPtr up-angled, right arrow pointer.
$MouseURResizePtr up-angled, right resize pointer.

Mouse Messages

These messages can be sent in response to and with a $MsgMouse message. These messages cannot be combined.

This message... indicates that the user...
$MouseLeftClick clicked the left mouse button once.
$MouseLeftDouble double-clicked the left mouse button.
$MouseLeftEndDrag pressed the left mouse button, dragged the mouse, and released the left mouse button.
$MouseLeftStartDrag clicked the left mouse button and dragged the mouse.
$MouseNone did not move the mouse.
$MouseRightClick clicked the right mouse button once.
$MouseRightDouble double-clicked the right mouse button.

Dialog Box Constants

Dialog box constants define the style for a dialog box. They are used with the WinFileDialog statement. The default constant is $FileDlgOpen. The $FileDlgCenter constant can be combined with either the $FileDlgOpen constant or the $FileDlgSaveAs constant.
The following table shows dialog box constants and their effects on the style of a dialog box.

Dialog box constant Effect
$FileDlgCenter Centers the dialog box in the middle of the window.
$FileDlgOpen Creates an open dialog box.
$FileDlgSaveAs Creates a Save As dialog box.

Hypertext Viewer Window Styles

The following table shows constants and associated event messages with the resulting styles they establish for hypertext viewer windows.

This constant... used with this event message... has this effect on the hypertext viewer window...
$HyperNoWordWrap $MsgOpenFile text is not word-wrapped in the hypertext viewer. A horizontal scroll bar is present.
$HyperScaleImage $MsgDisplayImage the image is scaled to fit in the hypertext viewer.
$HyperScrollImage $MsgDisplayImage the image is not scaled to fit. It can, however, be scrolled.

Clock Styles

Clock styles are used with the WinCreateClock statement. These styles can be combined using the BitOr statement.

For Windows, the defaults are $ClkBorderIn and $Clk12Hour.

For OS/2 the defaults are $ClkBorder and $Clk12Hour. The following table shows the constants that can be used with the WinCreateClock statement and the resulting clock styles.

With this constant... the clock...
$Clk12Hour is a 12-hour clock.
$Clk24Hour is a 24-hour clock.
$ClkBorder
(OS/2 default)
has a border.
$ClkBorderIn
(Windows default)
appears indented (3D).
$ClkBorderNone has no border.
$ClkBorderOut appears raised (3D).
$ClkHidden is hidden.

Message Box Styles

The following constants are used with the WinMessageBox statement to create message boxes. The default constants are $MBOK and $MBAPPMODAL. These resulting styles can be combined using the BitOr statement. For example, you can create an application modal dialog box with an Error icon and an OK button.

Button Styles

The following table shows the constants that can be used with the WinMessageBox statement and the resulting button styles.

With this constant... the message box...
$MBAbortRetryIgnore has three buttons: Abort, Retry, and Ignore.
$MBCancel in OS/2, has a Cancel button.
in Windows, has one button, which is labeled Cancel (same as $MBOK).
$MBDefButton1 has a user-defined button (#1).
$MBDefButton2 has a user-defined button (#2).
$MBDefButton3 The message box has a user-defined button (#3).
$MBEnter in OS/2, has an Enter button.
in Windows, has only one button, which is labeled OK (same as $MBOK).
$MBEnterCancel in OS/2, has two buttons: Enter and Cancel.
in Windows, has two buttons, which are labeled OK and Cancel (same as $MBOKCancel).
$MBOK has an OK button.
$MBOKCancel has two buttons: OK and Cancel.
$MBRetryCancel has two buttons: Retry and Cancel.
$MBYesNo has two buttons: Yes and No.
$MBYesNoCancel has three buttons: Yes, No, and Cancel.

Icon Styles

The following table shows the constants that can be used with the WinMessageBox statement and the resulting icon styles.

With this constant... the message box has...
$MBIconError an Error icon.
$MBIconInformation an Information icon.
$MBIconQuery a Query icon.
$MBIconWarning a Warning icon.
$MBNoIcon no icon.

Miscellaneous Styles

The following table shows the constants that can be used with the WinMessageBox statement and the resulting miscellaneous styles.

With this constant... the message box is...
$MBAppModal application modal.
$MBSysModal system modal.
$MBMoveable moveable. With this constant you can make set message boxes so that they can be moved around the screen.

Result Styles (Codes)

The following table shows the integer return format from WinMessageBox, which is equal to one of these constants.

This return code... indicates that the user pressed ...
$MBResultAbort Abort
$MBResultCancel Cancel
$MBResultEnter Enter
$MBResultError Error
$MBResultIgnore Ignore
$MBResultNo No
$MBResultOK OK
$MBResultRetry Retry
$MBResultYes Yes

Session Creation Flags

The following table shows the creation flags that can be used with the SysCreateSession. These styles cannot be combined, and there is no default session style.

Creation Flag Effect
$SessionAutoPosition The operating system determines the location of the session window
$SessionBackground This creates a session that runs in the background
$SessionInvisible This creates a session with an invisible window

Data Type Format Flags

Constants are used to format data of different types and can be used with string formatting operators. Each of the following statements is used to access a variable:

If you pass a value to one of these statements, you change the value of the variable. The constant $FmtDefault can be used to choose the default format for the data types listed above. (The format chosen depends on the data type you are using.)

Tip: For each of the following categories of format styles, the default style is in boldface. In the instances where multiple styles can be used in combination (in other words, they are not mutually exclusive), there is more than one default.

Boolean Format Flags

The following constants convert a Boolean value to a string in one of the formats shown. The default is $FmtBoolTrueFalse.

This constant... converts the Boolean value to a string in this format...
$FmtBoolTrueFalse either true or false.
$FmtBoolBinary either 0 or 1.
$FmtBoolYesNo either yes or no.

Date Format Flags

The following constants convert a date value to a string in one of the formats shown. These date formats can be combined. For example, you can choose mixed case, European format, and short names.

Tip: For each of the following categories of format flags, the default United States flag is in italics.

Case of Month, Day, and Year Format

Case Description
$FmtDateMixedCaseNames Displays month names in mixed case (for example, February).
Note: This is the default for all locales.
$FmtDateISOFormat Displays the ISO international date format (yyyymmdd). This is intended for use when a single application or database is shared by users from multiple, international locales.
$FmtDateAllCapsNames Displays month names in all uppercase (for example, FEBRUARY).

Order of Month, Day, and Year Format

Constant Description
$FmtDateDayMonthYear Orders subfields in the date with day first, followed by month, followed by year (for example, 31/1/1999).
$FmtDateMonthDayYear Orders subfields in the date with month first, followed by day, followed by year (for example 1/31/1999).
$FmtDateYearMonthDay Orders subfields in the date with year first, followed by month, followed by day (for example, 1999/1/31).

Century Format

Constant Description
$FmtDateFullYear Displays the full year including the century portion of a date (for example, 1999/1/31).
$FmtDateTruncateCentury Suppresses display of the century portion of a date (for example 4/22/99).


Note: No default is indicated for the century format because the default for century depends on the locale of the current workstation. The locale describes the workstation's cultural context, which is more than country; for example, Canadian versus French Canadian is a cultural context. The cultural context is also more than language; for example, French as spoken in Canada versus French as spoken in Switzerland.

In OS/2 the dates do not include the century. To add the century to a date in OS/2, use a DateFormat command.

Month Format

Constant Description
$FmtDateNumericMonth Displays months as numbers (for example 2/14/1999).
$FmtDateNamedMonth Displays month names in the language of the currently-selected country (for example, February 11, 1999 ).

Name Length Format

Constant Description
$FmtDateLongNames Displays the long form of month names (for example, February).
$FmtDateShortNames Displays the short (abbreviated) form of month names (for example, Feb).

Separator Format

Constant Description
$FmtDateDotSeparators Separates months, days, and years in dates with periods (for example, 2.13.1999).
$FmtDateSlashSeparators Separates months, days, and years in dates with slashes (for example, 2/13/1999).
$FmtDateDashSeparators Separates months, days, and years in dates with dashes (for example, 2-13-1999).

Padding

Constant Description
$FmtZeroPad Forces alignment by displaying two digits for day and month positions (for xample, 02/07/1999).

Tip: The special format flag $FmtDateNLSDefault can be used to indicate the default date format for the currently-selected locale.

Integer Format Flags

The following constants convert an integer value to a string in one of the following formats.
Tip: For each of the following format categories, the default United States flag is in italics.

Integer Format

Constant Description
$FmtIntDecimal Displays integers in decimal (base 10) form.
$FmtIntHexadecimal Displays integers in hexadecimal (base 16) form.

Integer Grouping Format

Constant Description
$FmtIntUngrouped Displays integers with no delimiters between thousand groups (for example, 1234567).
$FmtIntGroupedWithBlank Displays integers with thousand groups delimited by blanks(for example, 1 234 567).
$FmtIntGroupedWithComma Displays integers with thousand groups delimited by commas (for example, 1,234,567).
$FmtIntGroupedWithDot Displays integers with thousand groups delimited by periods (for example, 1.234.567).

Signed Format

Constant Description
$FmtIntSignNegOnly Causes negative integer values to be preceded by a minus sign. A plus sign, however, is suppressed in the case of positive values.
$FmtIntSigned Displays a plus or minus sign for all integer values.

Padding

Constant Description
$FmtZeroPad Displays leading zeros for one-digit integer values (for example, 09) and pads all the empty digits in a string

String Format Flags

The following constants convert a string value to one of the following formats.
Tip: Default United States style flags are in italics.

This constant... converts the string value to this format...
$FmtLeftJustify to a left-justified position within the output field.
$FmtRightJustify to a right-justified position within the output field.
$FmtBlankPad to a padded position with spaces within the output field. (This is the same as $FmtNoPad.)
$FmtNoPad to a padded position with spaces within the output field. (This is the same as $FmtBlankPad.)
$FmtZeroPad to a padded with zeros position within the output field.

Number For Real Formats

The following constants convert a real number value to a string in one of the following formats.
Tip: Default United States style flags are in italics.

Signed Format

Constant Description
$FmtRealSignNegOnly Suppresses the display of a plus sign for non-negative real numbers. (Only negative real numbers are signed.)
$FmtRealSigned Displays either a plus sign or a minus sign for all real values. (All real numbers are signed.)

Decimal Format

Constant Description
$FmtRealDecimalDot Displays the decimal point in real numbers, using a period (for example, 3.14159).
$FmtRealDecimalComma Displays the decimal point in real numbers using a comma (for example, 3,14159).

Grouping Format

Constant Description
$FmtRealGroupedWithBlank Displays real numbers with thousand groups delimited by blanks (for example, 1 234 567.00).
$FmtRealGroupedWithComma Displays real numbers with thousand groups delimited by commas (for example, 1,234,567,000).
$FmtRealGroupedWithDot Displays real numbers with thousand groups delimited by periods (for example, 1.234.567.000).
$FmtRealUngrouped Displays real numbers with no separators between thousand groups (for example, 1234567.00).

Padding

Constant Description
$FmtZeroPad Displays leading zeros for one-digit integer values (for example, 09) and pads all the empty digits in a string.


Tip: The format specifier for real numbers can also encode the number of digits displayed to the right of the decimal place. For example

 WinWrite ($Handle, r:10: BitOr (2,$FmtLeftJustify));

left justifies the output and displays two digits to the right of the decimal. By default, real numbers display six digits to the right of the decimal point.

Tip: You can combine a $FmtRealGroupedWithDot constant with a $FmtRealDecimalComma to achieve the result 1.234,567.

Time Format Flags

The following constants convert a time value to a string in one of the following formats.
Tip: Default United States flags are in italics.

This constant... converts a time value into a string that...
$FmtTimeAMPM displays 12-hour, AM or PM form (for example, 6:45 PM).
$FmtTimeColonSeparators delimits hours, minutes, and seconds with colons. This is the default format used to convert a time to a string (for example, 12:35:06).
$FmtTimeDotSeparators delimits hours, minutes, and seconds with periods (for example, 12.15.34).
$FmtTimeMilitary displays time in 24-hour, military fashion (for example, 18:35:17).
$FmtTimeWithoutSeconds excludes seconds when displaying time values.
$FmtTimeWithSeconds includes seconds when displaying time values.
$FmtZeroPad forces alignment by displaying two digits for each part of the time (for example, 02:09:37).

Font Style Flags

These style flags are used with WinCreateScrollWindow and WinSetFont. The styles can be combined.

This style flag... makes the font style...
$FontBold bold.
$FontItalic italic.
$FontPlain plain (normal).
$FontStrikeout strikeout.
$FontUnderscore underscored.

DDE Status Flags

A DDE status flag communicates the results of actions requested by the client to a server. The following are the DDE status flags for OS/2, some of which have no exact equivalent in Windows.

This status flag... has this effect in OS/2...
DDEAck The request is accepted.
Note: This flag is the same in Windows.
DDEAcknowledgeReq An acknowledgment is requested.
DDEAppStatus This is a bitmask that, when using (the Boolean operator) AND with the status word, reveals the application portion of the status.
DDEBusy The application is busy.
DDENoData There is no data for the requested topic.
DDENotProcessed The message is not understood.
DDEResponse The data is sent in response to a DDERequest.

File Searching Using SAIPATH

When TSD Script searches for objects such as .kbc files (parser), .dfc files (dialog box system), or .ico files (hypermedia controls), it uses the following search strategy and sequence to find them:

  1. If the file has an explicit directory specified, that directory is the only place searched.
  2. Searches the directories explicitly specified on the command line.
  3. Searches current working directory.
  4. Searches the directory where the kml.exe is located, where xx stands for the last two digits of the Developer's Toolkit release version number.
  5. Searches the directories specified in the SAIPATH environment variable.
  6. (OS/2 only) Searches the directories specified in the DPATH environment variable.
  7. Searches the directories specified in the PATH environment variable.

If the file cannot be found using this strategy, the tool returns an error message that indicates that the file was not found.


Tivoli Service Desk 6.0 Developer's Toolkit Script Language Reference

Return to Main Page

Copyright