PowerScript Functions

Table of Contents

Abs
ACos
AccessToken
Activate
AddCategory
AddColumn
AddData
Syntax 1: For all graph types except scatter
Syntax 2: For scatter graphs
AddItem
Syntax 1: For ListBox and DropDownListBox controls
Syntax 2: For PictureListBox and DropDownPictureListBox controls
Syntax 3: For ListView controls
Syntax 4: For ListView controls
AddItemArray
AddItemBlob
AddItemBoolean
AddItemDate
AddItemDateTime
AddItemNull
AddItemNumber
AddItemObject
AddItemString
AddItemTime
AddLargePicture
AddPicture
AddSeries
AddSmallPicture
AddStatePicture
AddToLibraryList
AppendParam
ApplyTheme
Arrange
ArrangeSheets
Asc
AscA
ASin
AsymmetricDecrypt
AsymmetricEncrypt
AsymmetricGenerateKey
AsymmetricSign
AsymmetricVerifySign
ATan
Base64Decode
Base64Encode
Beep
BeginTransaction (obsolete)
Blob
BlobEdit
BlobMid
BuildModel
Byte
Cancel
Syntax 1: for Pipeline objects
Syntax 2: for CompressorObject and ExtractorObject objects
CancelSync
CanUndo
CategoryCount
CategoryName
Ceiling
ChangeDirectory
ChangeMenu
Char
CharA
Check
ChooseColor
ClassList
ClassName
Syntax 1: For any object
Syntax 2: For variables
Clear
Syntax 1: For selected text
Syntax 2: For RichTextEdit controls
Syntax 3: For JSONPackage objects
ClearAll
ClearBoldDates
ClearHeaders
Syntax 1: for TokenRequest objects
Syntax 2: for OAuthRequest objects
ClearParams
ClearRequestHeaders
Clipboard
Syntax 1: For text
Syntax 2: For bitmaps of graphs
Close
Syntax 1: For windows
Syntax 2: For OLEStorage objects
Syntax 3: For OLEStream objects
Syntax 4: For trace files
CloseChannel
CloseTab
CloseUserObject
CloseWithReturn
CollapseItem
CommandParm
CommitDocking
CommitTransaction (obsolete)
Compress
ConnectToNewObject
ConnectToNewRemoteObject
ConnectToObject
ConnectToRemoteObject
ConnectToServer (obsolete)
ContainsKey
Copy
CopyRTF
Cos
Cpu
CreateDirectory
CreateInstance
CreateJsonArray
CreateJsonObject
CreatePage
Cut
DataCount
DataSource
Date
Syntax 1: For DateTime data and blobs
Syntax 2: For strings
Syntax 3: For combining numbers into a date
DateTime
Syntax 1: For creating DateTime values
Syntax 2: For extracting DateTime values from blobs
Day
DayName
DayNumber
DaysAfter
DBHandle
DebugBreak
Dec
DeleteCategory
DeleteColumn
DeleteColumns
DeleteData
DeleteItem
Syntax 1: For ListBox and DropDownListBox controls
Syntax 2: For ListView controls
Syntax 3: For TreeView controls
DeleteItems
DeleteLargePicture
DeleteLargePictures
DeletePicture
DeletePictures
DeleteSeries
DeleteSmallPicture
DeleteSmallPictures
DeleteStatePicture
DeleteStatePictures
DestroyModel
DirectoryExists
DirList
DirSelect
Disable
DisableCommit
DisconnectObject
DisconnectServer
Double
DoVerb
Drag
DraggedObject (obsolete)
Draw
EditLabel
Syntax 1: For editing a label in a ListView
Syntax 2: For editing a label in a TreeView
Enable
EnableCommit
EntryList
ExecRemote
Syntax 1: For sending single commands
Syntax 2: For commands over an opened channel
Exp
ExpandAll
ExpandItem
Extract
Fact
FileClose
FileCopy
FileDelete
FileEncoding
FileExists
FileLength
FileLength64
FileMove
FileOpen
FileRead
FileReadEx
FileSeek
FileSeek64
FileWrite
FileWriteEx
Fill
FillA
FillW (obsolete)
Find
FindCategory
FindClassDefinition
FindFunctionDefinition
FindItem
Syntax 1: For ListBox and DropDownListBox controls
Syntax 2: For ListView controls
Syntax 3: For ListView controls
Syntax 4: For TreeView controls
FindMatchingFunction
FindNext
FindSeries
FindTypeDefinition
FromAnsi
FromUnicode
GarbageCollect
GarbageCollectGetTimeLimit
GarbageCollectSetTimeLimit
GetAccessToken
GetActiveSheet
GetAlignment
GetApplication
GetArgElement
GetAutomationNativePointer
GetBody
Syntax 1: for TokenResponse objects
Syntax 2: for OAuthRequest objects
Syntax 3: for ResourceResponse objects
GetByte
GetByteArray
GetCertificateLabel (obsolete)
GetChildCount
GetChildItem
GetChildKey
GetChildrenList
GetColumn
GetCommandDDE
GetCommandDDEOrigin
GetCommandString
GetCompanyName
GetContextKeywords
GetContextService
GetCredentialAttribute (obsolete)
GetCurrentDirectory
GetData
Syntax 1: For data points in graphs
Syntax 2: For EditMask controls
Syntax 3: For data in an OLE server
GetDataDDE
GetDataDDEOrigin
GetDataLabelling
GetDataPieExplode
GetDataStyle
Syntax 1: For the colors of a data point
Syntax 2: For the line style and width used by a data point
Syntax 3: For the fill pattern or symbol of a data point
GetDataTransparency
GetDataValue
GetDateLimits
GetDbmlsyncPath
GetDisplayRange
GetDynamicDate
GetDynamicDateTime
GetDynamicDecimal
GetDynamicNumber
GetDynamicString
GetDynamicTime
GetEnvironment
GetExpiresIn
GetFileOpenName
GetFileSaveName
GetFirstSheet
GetFixesVersion
GetFocus
GetFolder
GetGlobalProperty (obsolete)
GetHeader
Syntax 1: for TokenRequest objects
Syntax 2: for TokenResponse objects
Syntax 3: for OAuthRequest objects
Syntax 4: for ResourceResponse objects
GetHeaders
Syntax 1: for TokenRequest objects
Syntax 2: for TokenResponse objects
Syntax 3: for OAuthRequest objects
Syntax 4: for ResourceResponse objects
GetHostObject
GetItem
Syntax 1: For ListView controls
Syntax 2: For ListView controls
Syntax 3: For TreeView controls
GetItemArray
GetItemBlob
Syntax 1
Syntax 2
GetItemBoolean
Syntax 1
Syntax 2
GetItemDate
Syntax 1
Syntax 2
GetItemDateTime
Syntax 1
Syntax 2
GetItemNumber
Syntax 1
Syntax 2
GetItemObject
GetItemString
Syntax 1
Syntax 2
GetItemTime
Syntax 1
Syntax 2
GetItemType
GetItemAtPointer
GetJsonBlob
GetJsonString
GetJWTToken
GetKey
GetLastReturn
GetLibraryList
GetMajorVersion
GetMessage
GetMinorVersion
GetName
GetNativePointer
GetNextSheet
GetOAuthToken
GetObjectRevisionFromRegistry
GetOrigin
GetParagraphSetting
GetParent
GetPin (obsolete)
GetRecordSet
GetRefreshToken
GetRemote
Syntax 1: For single DDE requests
Syntax 2: For DDE requests via an open channel
GetRequestHeader
GetRequestHeaders
GetResponseBody
GetResponseHeader
GetResponseHeaders
GetResponseStatusCode
GetResponseStatusText
GetRootItem
GetSelectedDate
GetSelectedRange
GetSeriesLabelling
GetSeriesStyle
Syntax 1: For the colors of a series
Syntax 2: For the line style and width used by a series
Syntax 3: For the fill pattern or symbol of a series
Syntax 4: For determining whether a series is an overlay
GetSeriesTransparency
GetShortName
GetSpacing
GetStatusCode
Syntax 1: for TokenResponse objects
Syntax 2: for ResourceResponse objects
GetStatusText
Syntax 1: for TokenResponse objects
Syntax 2: for ResourceResponse objects
GetStatus (obsolete)
GetSyncRegistryProperties
GetText
GetTextColor
GetTextStyle
GetTheme
GetToday
GetTokenError
GetTokenType
GetToolbar
GetToolbarPos
Syntax 1: For docked toolbars
Syntax 2: For floating toolbars
GetTransactionName (obsolete)
GetURL
GetValue
Syntax 1: for DatePicker control
Syntax 2: for JSONPackage object
GetValueBlob
GetValueBoolean
GetValueDate
GetValueDateTime
GetValueNumber
GetValueString
GetValueTime
GetValueToDataWindow
GetVersionName
Handle
HexDecode
HexEncode
Hide
HMAC
Hour
HyperLinkToURL
Idle
ImpersonateClient
ImportClipboard
ImportFile
ImportString
IncomingCallList
Init (obsolete)
InputFieldChangeData
InputFieldCurrentName
InputFieldDeleteCurrent
InputFieldGetData
InputFieldInsert
InputFieldLocate
InsertCategory
InsertClass
InsertColumn
InsertData
InsertDocument
InsertFile
InsertItem
Syntax 1: For ListBox and DropDownListBox controls
Syntax 2: For ListBox and DropDownListBox controls
Syntax 3: For ListView controls
Syntax 4: For ListView controls
Syntax 5: For TreeView controls
Syntax 6: For TreeView controls
InsertItemFirst
Syntax 1: For TreeView controls
Syntax 2: For TreeView controls
InsertItemLast
Syntax 1: For TreeView controls
Syntax 2: For TreeView controls
InsertItemSort
Syntax 1: For TreeView controls
Syntax 2: For TreeView controls
InsertObject
InsertPicture
InsertSeries
Int
Integer
InternetData
IntHigh
IntLow
InvokePBFunction
_Is_A (obsolete)
IsAlive
IsAllArabic
IsAllHebrew
IsAnyArabic
IsAnyHebrew
IsArabic
IsArabicAndNumbers
IsCallerInRole
IsDate
IsHebrew
IsHebrewAndNumbers
IsImpersonating
IsInTransaction (obsolete)
IsNull
IsNumber
IsPreview
IsSecurityEnabled
IsTime
IsTransactionAborted (obsolete)
IsValid
KeyCount
KeyDown
LastPos
Left
LeftA
LeftW (obsolete)
LeftTrim
LeftTrimW (obsolete)
Len
LenA
LenW (obsolete)
Length
LibraryCreate
LibraryDelete
LibraryDirectory
LibraryDirectoryEx
LibraryExport
LibraryImport
LineCount
LineLength
LineList
LinkTo
LoadDockingState
LoadFile
LoadString
LoadInk
LoadPicture
Log
Syntax 1: For all objects
Syntax 2: For ErrorLogging objects
LogTen
Long
Syntax 1: For combining integers
Syntax 2: For converting strings and blobs
LongLong
Syntax 1: For combining longs
Syntax 2: For converting strings and blobs
Lookup (obsolete)
Syntax 1: For CORBA-compliant EAServer components
Syntax 2: For instances of an EJB component
Lower
LowerBound
mailAddress
mailDeleteMessage
mailGetMessages
mailHandle
mailLogoff
mailLogon
mailReadMessage
mailRecipientDetails
mailResolveRecipient
mailSaveMessage
mailSend
Match
MatchW (obsolete)
Max
MD5
MemberDelete
MemberExists
MemberRename
MessageBox
Mid
MidA
MidW (obsolete)
Min
Minute
Mod
ModifyData
Syntax 1: For all graph types except scatter
Syntax 2: For scatter graphs
Month
Move
MoveTab
_Narrow (obsolete)
NextActivity
Now
ObjectAtPointer
OffsetPos
Open
Syntax 1: For windows of a known datatype
Syntax 2: For windows of unknown datatype
Syntax 3: For loading an OLE object from a file into a control
Syntax 4: For opening an OLE object in memory into a control
Syntax 5: For opening an OLE object in a file into an OLEStorage
Syntax 6: For opening an OLE storage member into a storage
Syntax 7: For opening OLE streams
Syntax 8: For opening trace files
OpenChannel
OpenSheet
OpenSheetAsDocument
OpenSheetDocked
OpenSheetFromDockingState
OpenSheetInTabGroup
OpenSheetWithParm
OpenSheetWithParmAsDocument
OpenSheetWithParmDocked
OpenSheetWithParmFromDockingState
OpenSheetWithParmInTabGroup
OpenTab
Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype
OpenTabWithParm
Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype
OpenUserObject
Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype
OpenUserObjectWithParm
Syntax 1: For user objects of a known datatype
Syntax 2: For user objects of unknown datatype
OpenWithParm
Syntax 1: For windows of a known datatype
Syntax 2: For windows of unknown datatype
OutgoingCallList
PageCount
PageCreated
ParentWindow
Paste
PasteLink
PasteRTF
PasteSpecial
PBAddCookie (Obsolete)
PBGetCookies (Obsolete)
PBGetMenuString
Pi
PixelsToUnits
Play
PointerX
PointerY
PopMenu
PopulateError
Pos
PosA
PosW (obsolete)
Position
Syntax 1: For editable controls, except RichTextEdit
Syntax 2: For RichTextEdit controls
Post
PostData
PostDataEnd
PostDataStart
PostEvent
PostURL
Preview
Print
Syntax 1: For printing a visual object in a print job
Syntax 2: For printing text in a print job
Syntax 3: For RichTextEdit controls
PrintBitmap
PrintCancel
PrintClose
PrintDataWindow
PrintDefineFont
PrintEx
PrintGetPrinter
PrintGetPrinters
PrintLine
PrintOpen
PrintOval
PrintPage
PrintRect
PrintRoundRect
PrintScreen
PrintSend (obsolete)
PrintSetFont
PrintSetPrinter
PrintSetSpacing
PrintSetup
PrintSetupPrinter
PrintText
PrintWidth
PrintX
PrintY
ProfileInt
ProfileString
Rand
Randomize
Read
Syntax 1: For reading into a string
Syntax 2: For character arrays or blobs
ReadData
Real
RecognizeText
RegistryDelete
RegistryGet
RegistryKeys
RegistrySet
RegistryValues
RelativeDate
RelativeTime
ReleaseAutomationNativePointer
ReleaseNativePointer
Remove
RemoveDirectory
RequestResource
Repair
Replace
ReplaceA
ReplaceText
ReplaceW (obsolete)
Reset
Syntax 1: For list boxes
Syntax 2: For graphs
Syntax 3: For trace files
ResetArgElements
ResetDataColors
ResetInk
ResetPicture
Resize
RespondRemote
Restart
ResumeTransaction (obsolete)
Retrieve
RetrieveOne
Reverse
RevertToSelf
RGB
Right
RightA
RightW (obsolete)
RightTrim
RightTrimW (obsolete)
RollbackOnly (obsolete)
RollbackTransaction (obsolete)
Round
RoutineList
Run
Save
Syntax 1: For InkPicture controls
Syntax 2: For OLE objects
SaveAs
Syntax 1: For graph objects
Syntax 2: For saving an OLE control to a file
Syntax 3: For saving an OLE control to an OLE storage
Syntax 4: For saving an OLE storage object to a file
Syntax 5: For saving an OLE storage object in another OLE storage
SaveDockingState
SaveDocument
SaveInk
SaveToFile
Scroll
ScrollNextPage
ScrollNextRow
ScrollPriorPage
ScrollPriorRow
ScrollToRow
Second
SecondsAfter
Seek
Syntax 1: For OLE stream objects
Syntax 2: For animation controls
SelectedColumn
SelectedIndex
SelectedItem
SelectedLength
SelectedLine
SelectedPage
SelectedStart
SelectedText
SelectionRange
SelectItem
Syntax 1: When you know the text of an item
Syntax 2: When you know the item number
Syntax 3: For TreeView controls
SelectObject
SelectTab
SelectText
Syntax 1: For editable controls (except RichTextEdit)
Syntax 2: For RichTextEdit controls and presentation styles
SelectTextAll
SelectTextLine
SelectTextWord
Send
SendDeleteRequest
SendGetRequest
SendPatchRequest
SendPostRequest
SendPutRequest
SendRequest
SeriesCount
SeriesName
SetAbort
Syntax 1: For OLETxnObject objects
Syntax 2: For TransactionServer objects
SetAccessToken
SetAlignment
SetArgElement
SetAutomationLocale
SetAutomationPointer
SetAutomationTimeout
SetBody
SetBoldDate
SetByte
SetColumn
SetComplete
Syntax 1: For OLETxnObject objects
Syntax 2: For TransactionServer objects
SetData
SetDataDDE
SetDataLabelling
SetDataPieExplode
SetDataStyle
Syntax 1: For setting a data point's colors
Syntax 2: For the line associated with a data point
Syntax 3: For the fill pattern and symbol of a data point
SetDataTransparency
SetDateLimits
SetDropHighlight
SetDynamicParm
SetFirstVisible
SetFocus
SetGlobalProperty (obsolete)
SetHeader
Syntax 1: for TokenRequest objects
Syntax 2: for OAuthRequest objects
SetHeaders
Syntax 1: for TokenRequest objects
Syntax 2: for OAuthRequest objects
SetItem
Syntax 1: For ListView controls
Syntax 2: For ListView controls
Syntax 3: For TreeView controls
SetJWTToken
SetLevelPictures
SetLibraryList
SetMask
SetMessage
SetMicroHelp
SetNewMobiLinkPassword
SetNull
SetOAuthToken
SetOverlayPicture
SetParagraphSetting
SetParm
SetPicture
SetPointer
Syntax 1: System-defined shape
Syntax 2: File-defined shape
SetPosition
Syntax 1: For positioning windows and controls in windows
Syntax 2: For positioning objects within a DataWindow
SetProfileString
SetRange
SetRecordSet
SetRedraw
SetRemote
Syntax 1: For single DDE requests
Syntax 2: For DDE requests via an open channel
SetRequestHeader
SetRequestHeaders
SetResultSet
SetSelectedDate
SetSelectedRange
SetSeriesLabelling
SetSeriesStyle
Syntax 1: For setting a series' colors
Syntax 2: For lines in a graph
Syntax 3: For the fill pattern and symbols in a graph
Syntax 4: For creating an overlay in a graph
SetSeriesTransparency
SetSheetID
SetSpacing
SetState
SetSyncRegistryProperties
SetTextColor
SetTextStyle
SetTimeout (obsolete)
SetToday
SetToolbar
SetToolbarPos
Syntax 1: For docked toolbars
Syntax 2: For floating toolbars
SetTop
SetTraceFileName
SetTransPool
SetValue
Syntax 1: for DatePicker control
Syntax 2: for JSONPackage object
SetValueBlob
SetValueBoolean
SetValueByDataWindow
SetValueDate
SetValueDateTime
SetValueNumber
SetValueString
SetValueTime
SHA
SharedObjectDirectory
SharedObjectGet
SharedObjectRegister
SharedObjectUnregister
Show
ShowHeadFoot
ShowHelp
ShowPopupHelp
Sign
SignalError
Sin
Sleep
Sort
Syntax 1: For TreeView controls
Syntax 2: For ListView controls
SortAll
Space
Sqrt
Start
Syntax 1: For executing pipeline objects
Syntax 2: For activating timing objects
StartHotLink
StartServerDDE
State
StepIt
Stop
Syntax 1: For deactivating timing objects
Syntax 2: For stopping an animation from playing
StopHotLink
StopServerDDE
String
Syntax 1: For formatting data
Syntax 2: For blobs
Submit
SuspendTransaction (obsolete)
SymmetricDecrypt
SymmetricEncrypt
Synchronize
Syntax 1: For synchronization without parameters
Syntax 2: For synchronization with parameters
SyntaxFromSQL
SystemRoutine
TabPostEvent
TabTriggerEvent
Tan
Text
TextLine
Time
Syntax 1: For DateTime and blob values
Syntax 2: For strings
Syntax 3: For integers
Timer
ToAnsi
Today
Top
TotalColumns
TotalItems
TotalSelected
ToUnicode
TraceBegin
TraceClose
TraceDisableActivity
TraceEnableActivity
TraceEnd
TraceError
TraceOpen
TraceUser
TriggerEvent
TriggerPBEvent
Trim
TrimW (obsolete)
Truncate
TrustVerify (obsolete)
TypeOf
Uncheck
Undo
UnitsToPixels
UpdateLinksDialog
Upper
UpperBound
UrlDecode
UrlEncode
Which
WordCap
WorkSpaceHeight
WorkSpaceWidth
WorkSpaceX
WorkSpaceY
Write
XMLParseFile
XMLParseString
Year
Yield

About this chapter

This chapter provides syntax, descriptions, and examples for PowerScript functions.

Contents

The functions are listed alphabetically.

See also

For information about functions that apply to DataWindows or DataStores, see also DataWindow Reference. Methods that apply to DataWindows, but not to other PowerBuilder controls, are listed only in DataWindow Reference.