The following is a list of CanDo! Commands & Functions available in CanDo! V3.008 (alphabetical order):

Generated on 30-Sep-2000

A good programmer should be able to figure out what all the various [] & {}mean. I realize however, that it's all a moot point

if you don't have CanDo!.


Home Page, Favorite Links, CanDo! page, C Programming page

AbortDoubleClick -- AbortDoubleClick

Absolute -- Integer = Absolute( Number )

ACos -- Real = ACos( RealNumber )

AdjustPeriod -- AdjustPeriod {Period}, {Channel (0-3)}

AdjustVolume -- AdjustVolume {Volume}, {Channel (0-3)}

Alias -- Variable = Alias( {VarName} )

AnimationStatus -- Logical = AnimationStatus

AnsiPressed -- Ansi = AnsiPressed

AnyChangedBuffers -- Logical = AnyChangedBuffers

AreaCircle -- AreaCircle xctr, yctr, radius

AreaCopy -- AreaCopy x, y, width, height, destx, desty

AreaEllipse -- AreaEllipse xctr, yctr, xradius yradius

AreaPalette -- AreaPalette x, y, width, height [,rows [,lowcolor [,highcolor ]]]

AreaPolygon -- x1,y1,x2,y2,x3,y3 [,x4,y4,x5,y5,x6,y6]

AreaRectangle -- x,y,width,height

AreaScroll -- x,y,width,height,deltax,deltay

ArgCount -- Integer = ArgCount

Arg1 -> Arg10 -- Argument = Arg1

Arguments -- Arguments <Varname>[={default}] [,<Varname>[={default}] ...]

Ascii -- Integer = Ascii( String ) ex: Ascii( "A" )

ASin -- Angle = ASin( RealOrInteger )

AskForFileName -- Name = AskForFileName( {Def} [,{Title} [,{X}[,{Y} [,{W} [,{H}]]]]])

AskForHelp -- Nothing = AskForHelp( {FileName} ,{NodeName}[,{PubScreen}] )

AskForResponse -- Select = AskForResponse( {Message} [,{Title}[,{Choices}]] )

AssignFunction -- FuncVar = AssignFunction({RoutineName})

AssignFunctionValue -- NewFuncVar = AssignFunctionValue({FunctionVar})

ATan -- Angle = ATan( RealNumber )

AttachObject -- AttachObject {ObjectName} [,{Arg1} [,up to ten arguments]]

Audio -- Audio {Logical (ON|OFF)} [,{Channel (0-3)}]

AvailableChipMemory -- Integer = AvailableChipMemory

AvailableFastMemory -- Integer = AvailableFastMemory

AvailableMemory -- Integer = AvailableMemory

BreakPoint -- BreakPoint ;Place a break point in a script.

BrushAnims -- BrushAnims {Logical (TRUE|FALSE)}

BufferType -- BufferType = BufferType({BufferName})

BumpRevision -- String = BumpRevision({CurrentRevision})

CanDoLegalNotice -- String = CanDoLegalNotice

CardName -- Name = CardName

Case -- Result = Case( {Index}, {Expression1} [,up to ten expressions] )

CauseError -- CauseError {errorcode}

CenterString -- String = CenterString({String}, {Length} [,{Fillstring}])

Char -- String = Char({Integer})

CharsToBegOfLine -- String = CharsToBegOfLine

CharsToEndOfLine -- String = CharsToEndOfLine

CharsToHex -- HexString = CharsToHex({String})

CheckBreakFlags -- string = CheckBreakFlags

Clear -- Clear DOCUMENT | LINE

ClearClipRegions -- ClearClipRegions

ClearWindow -- ClearWindow [{ColorReg}]

ClipBrush -- ClipBrush {X}, {Y}, {Width}, {Height}, {BrushBufferName}[,<memflag == CHIP>]

ClipIconImage -- ClipIconImage {IconBufferName}, {BrushBufferName}[,{AltBrushBufferName}]

ClipPicture -- ClipPicture {PictureBufferName} [,<memflag == CHIP>]

ClipTransparentColor -- Integer = ClipTransparentColor

Close -- Close {BufferName}

ClosePendingWindow -- ClosePendingWindow

ColorOfPixel -- ColorReg = ColorOfPixel({X}, {Y})

CopyDocumentTo -- CopyDocumentTo {document}

Cos -- Value = Cos({Angle})

CosH -- Value = CosH({Value})

CreateBrush -- CreateBrush {BufferName}, {Width}, {Height}, {Depth}

CurrentListenTo -- Text = CurrentListenTo

CurrentSongName -- String = CurrentSongName

CurrentSongTempo -- Integer = CurrentSongTempo

CurrentSongType -- Integer = CurrentSongType

CurrentSongVolume -- Integer = CurrentSongVolume

CurrentSpeakTo -- Text = CurrentSpeakTo

CycleColors -- CycleColors {FromColorReg}, {ToColorReg}[,<FORWARD | BACKWARD>]

DeckName -- String = DeckName

DefaultTool -- FilePath = DefaultTool({IconBufferName})

DegToRad -- RadianAngle = DegToRad({DegreeAngle})

Delay -- Delay {Minutes}, {Seconds}, {Jiffies}

Delete -- Delete <flags>[,{Count}] where <flags> = LINE, CHARACTER, TOSTARTOFLINE, TOENDOFLINE

DeleteArrayEntry -- DeleteArrayEntry <ArrayVar>, {ArrayIndex}

DetachObject -- DetachObject {ObjectName}

DisableObject -- DisableObject {ObjectName}

Dispose -- Dispose <VarName1> [,<VarName2> [,up to ten VarNames]]

DisposeAll -- DisposeAll

Do -- Do {RoutineName} [,{Argument1} [,up to ten arguments]] ;Command form

Do -- value = Do({RoutineName} [,{Arg1} [,up to 10 arguments]]) ;Function form

DocumentName -- DocBufName = DocumentName

DoObjectScript -- DoObjectScript {ObjectName},<ScriptType> [,{Argument1} [,up to ten arguments]]

where <ScriptType> ==

BEFOREATTACHMENT

ONDOWN

BEFORERENDER

BEFOREDETACHMENT

ONDRAG

ONINSERTED

MESSAGEFROMPARENTDECK

ONRELEASE

ONEVERYFRAME

MESSAGEFROMSUBDECK

ONCLICK

ONNEWPOSITION

ONAPPEVENT

ONDEACTIVATED

ONREMOVED

ONCLOSEBUTTON

ONUP

ONARRIVALATDESTINATION

ONSTART

OCCURED

ONRESIZED

ONSTOP

ONACTIVATED

ONREPEATED

AFTERATTACHMENT

ONDOUBLECLICK

AFTERSELECTION

DoOnError -- DoOnError {RoutineName} [{Argument1} [,up to ten arguments]]

Dos -- Dos {DOSCommandLine} [,<STDOUT>]

DrawBorder -- DrawBorder {X}, {Y}, {Width}, {Height}, <borderflags> [,{Pen1} [,{Pen2}]]

where <borderflags> ==

OUTLINE

BEVEL

HEAVYEMBOSSED

BOX

BUTTONIN

LEFT

CHECKNO

EMBOSSED

SHADOW

BUTTONOUT

RIGHT

CHECKYES

ROLLO

SCHECKYES

DOWN

DOUBLEOUTLINE

DOUBLEBEVEL

INVERT

SCHECKNO

UP

INVERT - Switches Shine and Shadow colors to make border appear pushed in.

DrawCircle -- DrawCircle {X}, {Y}, {Radius}

DrawEllipse -- DrawEllipse {X}, {Y}, {XRadius}, {YRadius}

DrawLine -- DrawLine {X1}, {Y1}, {X2}, {Y2}

DrawPixel -- DrawPixel {X}, {Y}

DrawPolygon -- DrawPolygon {X1}, {Y1}, {X2}, {Y2}, {X3}, {Y3} [,up to six points]

DrawRectangle -- DrawRectangle {X}, {Y}, {Width}, {Height}

DrawTo -- DrawTo {X}, {Y}

DupeString -- String = DupeString({String}, {Count})

Echo -- Echo [{String} [,<NOLINE>]]

Else -- Else

ElseIf -- ElseIf {Logical Expression}

EnableObject -- EnableObject {ObjectName} [,<switch == CLEAR>]

EndIf -- EndIf

EndLoop -- EndLoop

ErrorCode -- Integer = ErrorCode

ErrorLineNumber -- Integer = ErrorLineNumber

ErrorObjectName -- String = ErrorObjectName

ErrorObjectType -- String = ErrorObjectType

Errors -- Logical = Errors

ErrorScriptName -- String = ErrorScriptName

ErrorScriptType -- String = ErrorScriptType

ErrorSourceLine -- String = ErrorSourceLine

ErrorText -- String = ErrorText

Evaluate -- Result = Evaluate({Expression})

EvaluateExpression -- Result = EvaluateExpression({Expression})

Exists -- Logical = Exists({FilePath})

ExitLoop -- ExitLoop

ExitScript -- ExitScript [{Result}]

Exp -- Value = Exp({Value})

False -- Logical = False

FastFeedback -- FastFeedback {Logical == TRUE | FALSE}

FileOf -- FileName = FileOf({FilePath})

FileReadChars -- FileReadChars {FileReadBufferName}, <VarName>, {Count} [,<HEX>]

FileReadLine -- FileReadLine {FileReadBufferName}, <VarName>

FileSize -- Integer = FileSize({FilePath})

FileType -- String = FileType({FilePath})

FileWriteChars -- FileWriteChars {FileWriteBufferName}, {String}[,{Count}[,<HEX>]

FileWriteLine -- FileWriteLine {FileWriteBufferName}, {String}

FillToBorder -- FillToBorder {X}, {Y}, {ColorReg}

FilterDocument -- FilterDocument {DOSWildCardPattern}

FindChars -- Integer = FindChars({SourceString}, {SearchString}[,{StartAtChar}])

FindWord -- Integer = FindWord({SourceString}, {SearchString}[,{StartAtWord} [,{WordDelimiters}]])

FirstArrayIndex -- ArrayIndex = FirstArrayIndex(<ArrayVar>)

FirstCard -- FirstCard [{Arg1} [,up to ten arguments]]

FloodFill -- FloodFill {X}, {Y}

Flush -- Flush {BufferName}

FlushAll -- FlushAll

FormatValue -- String = FormatValue({Value}, {FormatString})

Examples of FormatValue():

Value:

Format string:

Result:

29.5

"Total $##,###.00"

"Total $29.50"

-125.6

"____.___"

"-125.6 "

35437.476

"___,___,__0.00"

"35,437.48"

-.1

"___,___,__0.00"

"-0.10"

4194

" 00000 Zip Code"

" 04194 Zip Code"

45

"+_____"

"+45"

.000432

"0.0000E+00"

"4.3200E-04"

Fraction -- RealValue = Fraction({Number})

FrameOfAnimation -- FrameNumber = FrameOfAnimation({BAnimBufferName})

GetArgs -- Variable = GetArgs({String}, [,{Index}])

GetAttr -- GetAttr {DocumentObject}, <NUMBEROFCOLUMNS | NUMBEROFLINES | LEFTCOLUMN | TOPLINE>, <AttrReturned>

GetBrushAnimCoordinates -- GetBrushAnimCoordinates {BAnimBufferName}, <XVarName>,<YVarName>

GetBufferInfo -- GetBufferInfo {BufferName}, <Var1>[,<Var2>[,<Var3>[,<Var4>]]]

BufferType:

Var1:

Var2:

Var3:

Var4:

Picture

Width

Height

Depth

---------

Brush

Width

Height

Depth

---------

BrushAnim

Width

Height

Depth

# of Frames

Sound

Samples

Seconds

Rate

---------

Documents

Lines

Longest Line

Size

---------

GetChars -- Text = GetChars({String}, {StartingChar}, {NumberOfChars})

GetDBObjects -- RecordVar = GetDBObjects .Fields | .Buttons | .Lists | .Integers

GetDiskInfo -- GetDiskInfo {FilePath}, <NumberOfBlocksVar> [,<NumberUsedVar> [,<BytesPerBlockVar>]]

GetFileInfo -- GetFileInfo {FilePath}, <SizeInBytesVar> [,<NumberOfBlocksVar> [,<AttributesVar> [,<DateVar> [,<TimeVar> [,<CommentVar>]]]]]

GetFontInfo -- GetFontInfo <WINDOW | SCREEN>, <FontName>[, <FontSize>]

GetInsertedLineColors -- GetInsertedLineColors <Foreground>, <AltForeground>

GetLineAttribute -- GetLineAttribute <Attribute>, <color>

GetPropPosition -- GetPropPosition {ObjectName}, <HorizPosVarName> [,<VertPosVarName>]

GetPropRange -- GetPropRange {ObjectName},<LowHorizVarName>,<HighHorizVarName> [,<LowVertVarName>, <HighVertVarName>]

GetPropVisibleRange -- GetPropVisibleRange {ObjectName}, <DisplayHorizVarName> [,<DisplayVertVarName>]

GetRGB -- GetRGB {ColorReg}, <RedVar>, <GreenVar>, <BlueVar>

GetScreenPen -- ColorReg = GetScreenPen({WhichEntry})

GetTextDimensions -- GetTextDimensions {String},<WidthVarName>, <HeightVarName> [,<BaselineVarName>]

GetTextExtent -- GetTextExtent <string>, <width>, <height>

GetTextFit -- GetTextFit <string>, <width>, <numchars>

GetViewOffset -- GetViewOffset <XVarName>, <YVarName>

GetWindowLimits -- GetWindowLimits <MinWidthVar>, <MinHeightVar>,<MaxWidthVar>,<MaxHeightVar>

GetWord -- String = GetWord({String}, {WordNum} [, {WordDelimiters}])

Global -- Global <VarName1>, [<VarName2>,... [up to 10 VarNames]]

GotoCard -- GotoCard {CardName} [,{Arg1} [,up to ten arguments]]

GotoEndLoop -- GotoEndLoop

HexToChars -- String = HexToChars({HexString})

HexToInteger -- Integer = HexToInteger({HexString})

HiRes -- Logical = HiRes

IconHighlight -- String = IconHighlight({IconBufferName})

IconType -- String = IconType({IconBufferName})

If -- If {LogicalExpression}

IfError -- IfError

IfThen -- Result = IfThen({Logical}, {TrueExpression} [,{FalseExpression}])

Infinity -- Real = Infinity

Input -- String = Input({Prompt})

InsertArrayEntry -- InsertArrayEntry <ArrayVar>, {ArrayIndex}

InsertBufferList -- InsertBufferList

InsertChangedBufferList -- InsertChangedBufferList

InsertChars -- String = InsertChars({SourceString}, {DestinationString}[,{StartAtChar}])

InsertDeviceList -- InsertDeviceList [<flags = PHYSICAL | ASSIGN | ALL>]

InsertDirectoryList -- InsertDirectoryList [<flags = FILESONLY | DIRECTORIESONLY | ALL>]

InsertDocument -- InsertDocument {SourceDocumentName} [,{StartingLine}[,{LineCount}]]

InsertEffectsList -- InsertEffectsList {Flags = WINDOW | BRUSH | PALETTE}

InsertMessagePortList -- InsertMessagePortList

InsertPubScreenList -- InsertPubScreenList

InsertRecordNames -- InsertRecordNames <RecordVar>

InsertStartingMessage -- InsertStartingMessage

InsertToolTypeList -- InsertToolTypeList {IconBufferName}

InsertVariableNames -- InsertVariableNames

InstallClipRegion -- InstallClipRegion {X}, {Y}, {Width}, {Height}[,<methodflags = ONLY | INTERSECT | NOT | MERGE | INVERSE>]

Integer -- Integer = Integer({Expression})

IntegerFrom -- Integer = IntegerFrom({ObjectName})

IntegerToHex -- HexString = IntegerToHex({Integer})

Interlace -- Logical = Interlace

IntuitionVersion -- Integer = IntuitionVersion

IsAlias -- Logical = IsAlias(<VarName>)

KeyPressed -- String = KeyPressed

Returned strings are:

0

I

F1

CONTROL

NUM4

RIGHTAMIGA

1

J

F2

DELETE

NUM5

RIGHTSHIFT

2

K

F3

DOWN

NUM6

SEMICOLON

3

L

F4

ENTER

NUM7

SINGLEQUOTE

4

M

F5

EQUAL

NUM8

SLASH

5

N

F6

ESCAPE

NUM9

SPACE

6

O

F7

HELP

NUMASTERISK

TAB

7

P

F8

HYPHEN

NUMCLOSEPAR

UP

8

Q

F9

INTER1

NUMHYPHEN

9

R

F10

INTER2

NUMOPENPAR

A

S

ACCENT

LEFT

NUMPERIOD

ANY

B

T

AMIGA

LEFTALT

NUMPLUS

C

U

BACKSLASH

LEFTAMIGA

NUMSLASH

D

V

BACKSPACE

LEFTSHIFT

OPENBRACK

E

W

CAPSLOCK

NUM0

PERIOD

F

X

CLOSEBRACK

NUM1

RETURN

G

Y

COMMA

NUM2

RIGHT

H

Z

COMMODORE

NUM3

RIGHTALT

LargestChunkOfMemory -- Integer = LargestChunkOfMemory

LastArrayIndex -- ArrayIndex = LastArrayIndex(<ArrayVar>)

LastCard -- LastCard [{Argument1} [,up to ten arguments]]

LeftJustify -- String = LeftJustify({String}, {Width} [,{Fillstring}])

LengthOfLine -- Integer = LengthOfLine

Let -- Let <VarName>={Expression} [,<VarName>={Expression}, [...up to 10 VarNames with Expressions]]

LibraryVersion -- String = LibraryVersion

Limit -- Integer = Limit({MinLimit}, {MaxLimit}, {TestInteger})

LinesInDocument -- Integer = LinesInDocument

ListenTo -- ListenTo {ARexxPortName}

LoadBrush -- LoadBrush {FilePath}[,{BrushBufName}[,<flags = DELAYLOAD | ASNEEDED | OVERWRITE | CHIP>]]

LoadBrushAnim -- LoadBrushAnim {FilePath} [,{BAnimBufferName}[,<loadflags>]]

LoadDocument -- LoadDocument {FilePath} [,{DocumentBufferName} [,<loadflags>]]

LoadIcon -- LoadIcon {FilePath} [,{IconBufName}[,<flags = OVERWRITE | CHIP | DELAYLOAD | ASNEEDED>]]

LoadPalette -- LoadPalette {FilePath}[,{PalBufName}[,<flags = OVERWRITE | CHIP | DELAYLOAD | ASNEEDED>]]

LoadPicture -- LoadPicture {FilePath} [,{PictureBufferName} [,<loadflags>]]

LoadShape -- LoadShape {BrushFile}[, {ShapeBuf}[, <Options = CHIP | OVERWRITE | ASNEEDED | DELAYLOAD>]]

LoadSound -- LoadSound {FilePath} [,{SndBufName}[,<flags = ONCE | CONTINUOUS | WAIT | QUEUE | QUEUEPREVIOUS>]]

LoadSubDeck -- LoadSubDeck {FilePath} [,{SubDeckBufferName} [,<ASNEEDED>]]

LoadVariable -- Result = LoadVariable({FilePath})

Local -- Local <VarName1>[={value1}] [,<VarName2>[={value2}] ...]

LockPalette -- LockPalette [{FirstColor}[, {LastColor}]]

Log10 -- Value = Log10({Value})

LogE -- Value = LogE({Value})

Logical -- LogicalValue = Logical({Expression})

Loop -- Loop [<LoopVar>, {Var1}[, {Var2}[, {Var3}]

LowerCase -- String = LowerCase({String})

MakeDocument -- MakeDocument {DocumentBufferName}

MakeIcon -- MakeIcon {IconBufferName}, <flags = PROJECT | TOOL>, {BrushBufferName} [,{AltBrushBufferName}]

Match -- Integer = Match({ToLocate}, {MatchingData1}[,up to ten matching datas])

Max -- Integer = Max({Integer1}, {Integer2} [,up to ten integers])

MaxInteger -- Integer = MaxInteger

MaxValue -- Value = MaxValue

MessageErrorCode -- Integer = MessageErrorCode - See 'SendMessageNORESULT'

MessageReturned -- Text = MessageReturned - See 'SendMessage NORESULT'

Min -- Integer = Min({Integer1}, {Integer2} [,up to ten integers])

MinInteger -- Integer = MinInteger

MinValue -- Value = MinValue

MouseX -- Integer = MouseX

MouseY -- Integer = MouseY

MoveBrushAnim {BAnimBufName}, {XVel},{YVel}[,{XAccel},{YAccel}[,{Frames}[,<flag = QUEUE>]]]

MoveBrushAnimTo -- MoveBrushAnimTo {BAnimBufferName}, {DestX}, {DestY}[,{Frames} [,<flag = QUEUE>]]

MoveCursor -- MoveCursor <UP | DOWN | LEFT | RIGHT> [,{Count}]

MoveCursorTo <STARTOF | ENDOF & DOCUMENT | LINE | NEXTWORD | THISWORD | PREVIOUSWORD> [,{Count}]

MoveObject -- MoveObject {ObjectName}, {X}, {Y}

MovePen -- MovePen {X}, {Y}

MoveScreen -- MoveScreen {DeltaX}, {DeltaY}

MoveWindow -- MoveWindow {DeltaX}, {DeltaY}

NewLine -- NewLine

NextArrayIndex -- ArrayIndex = NextArrayIndex(<ArrayVar>, {ArrayIndex})

NextCard -- NextCard [{Argument1} [,up to ten arguments]]

No -- Logical = No

Nop -- Nop

NotANumber -- Real = NotANumber

Nothing -- NullString = Nothing

NTSC -- Logical = NTSC

NumberOfArrayEntries -- Integer = NumberOfArrayEntries(<ArrayVar>)

NumberOfChars -- Integer = NumberOfChars({String})

NumberOfWords -- Integer = NumberOfWords({String} [,{WordDelimiters}])

ObjectAttached -- Logical = ObjectAttached({ObjectName})

ObjectName -- String = ObjectName

ObjectState -- Logical = ObjectState({ObjectName})

Off -- Logical = Off

On -- Logical = On

OpenDeck -- Result = OpenDeck({DeckName} [,{string1}... [up to 10 Arguments]]

OpenFile {FilePath}, {FileIOBufName}, <READONLY | WRITEONLY>, <NEWFILE | OLDFILE | APPEND>

OpenRequester -- OpenRequester {SubDeckBufferName}, {CardName} [,{Arg1} [,up to ten arguments]]

OpenWindow -- OpenWindow {SubDeckBufferName}, {CardName}[,{Arg1} [,up to ten arguments]]

ParentOf -- PathName = ParentOf({PathName})

PathAndFile -- FilePath = PathAndFile({PathName}, {FileName})

PathOf -- PathName = PathOf({FilePath})

PatternMatch -- Boolean = PatternMatch({String}, {Pattern})

PenA -- ColorReg = PenA

PenB -- ColorReg = PenB

PenO -- ColorReg = PenO

Perform -- Perform {String}

PerformDocument -- PerformDocument {Document}

Pi -- Real = Pi

PlaySong -- PlaySong {filename or filepattern} [, WAIT CONTINUOUS]

PlaySound {SoundBufferName}[,<ONCE | CONTINUOUS | WAIT | QUEUE | QUEUEPREVIOUS> [,{PeriodRate}]]

PlaySoundSequence {DocBufName}[,<ONCE | CONTINUOUS | WAIT | QUEUE | QUEUEPREVIOUS> [,{PerRate}]]

Pointer -- Pointer {Logical = ON | OFF}

PositionOfWord -- Integer = PositionOfWord({String}, {WordNum} [,{WordDelimiters}])

PositionOnLine -- PositionOnLine {LineNumber}

PreviousArrayIndex -- Integer = PreviousArrayIndex(<ArrayVar>, {ArrayIndex})

PreviousCard -- PreviousCard [{Arg1} [,up to ten arguments]]

PrintScreen -- PrintScreen [{x} [,{y} [,{width} [,{height}]]]]

PrintText -- PrintText {String} [, {X}, {Y}]

PrintWindow -- PrintWindow [{x} [,{y} [,{width} [,{height}]]]]

PubScreenExists -- Boolean = PubScreenExists({ScreenName})

QualifiersPressed -- String = QualifiersPressed

Quit -- Quit [{Result}]

RadToDeg -- DegreeAngle = RadToDeg({RadianAngle})

RamScram -- RamScram

Random -- Integer = Random({MinimumInteger}, {MaximumInteger})

RawKeyCode -- Integer = RawKeyCode

RayTo -- RayTo {X}, {Y}

Real -- RealValue = Real({expression})

ReattachObject -- ReattachObject {ObjectName} [,{Arg1}[,up to ten arguments]]

RecreateMask -- RecreateMask {BufferName} [,{TransparencyColor}]

RefreshObject -- RefreshObject {DocumentObjectName}

RemoveBrushAnim -- RemoveBrushAnim {BAnimBufferName}

RemoveChars -- String = RemoveChars({String},{StartAtChar},{NumberOfChars})

RenderTo -- RenderTo <WINDOW | BUFFER> [,{BufferName}]

Replace -- Replace {SearchString}, {ReplaceString}[,<GLOBAL | NOCASE | BYWORD>]

ReplaceAttribute -- ReplaceAttribute <GLOBAL | COLOR>, {Old} ,{New}

ReplyARexxWith -- ReplyARexxWith <ERROR | MESSAGE | NOERROR> [,{Message or ErrorCode}]

ResetBrushAnimFrame -- ResetBrushAnimFrame {BAnimBufferName} [,{FrameNumber}]

ResizeWindow -- ResizeWindow {Width}, {Height}

ReverseDocument -- ReverseDocument

RightJustify -- String = RightJustify({String}, {Length} [,{Fillstring}])

Round -- Value = Round({Value} [,{DigitPlace}])

SaveAllChangedBuffers -- SaveAllChangedBuffers

SaveBrush -- SaveBrush {BrushBufferName} [,{SaveFilePath}]

SaveDocument -- SaveDocument {DocumentBufferName} [,{FilePath}[,<FTXT | ASCII>]]

SaveIcon -- SaveIcon {IconBufferName} [,{SaveFilePath}]

SavePicture -- SavePicture {PictureBufferName} [,{SaveFilePath}]

SaveVariable -- SaveVariable <VarName>, {FilePath}

ScreenAddress -- Integer = ScreenAddress

ScreenColors -- Integer = ScreenColors

ScreenHeight -- Integer = ScreenHeight

ScreenModeID -- Integer = ScreenModeID

ScreenTitle -- String = ScreenTitle

ScreenTitleBar -- ScreenTitleBar {Logical = ON | OFF}

ScreenTo -- ScreenTo <FRONT | BACK>

ScreenWidth -- Integer = ScreenWidth

ScreenX -- Integer = ScreenX

ScreenY -- Integer = ScreenY

SearchArray -- ArrayIndex = SearchArray(<ArrayVar>, {DataToSearchFor}[,{KeyString} [,{StartAtIndex}]])

SearchFor -- SearchFor {SearchString} [,<BYWORD | NOCASE>]

SearchForAttribute -- SearchForAttribute <COLOR> ,{Value}

SearchFound -- Logical = SearchFound

SendMessage -- SendMessage {Message} [,<ASYNC | NORESULTS>]

SendToParentDeck -- SendToParentDeck [{Argument1} [,up to ten arguments]]

SendToSubDeck -- SendToSubDeck {SubDeckBufferName} [,{Argument1}[,up to ten arguments]]

SetAreaDrawMode -- SetAreaDrawMode <NORMAL | OUTLINE>

SetAttr -- SetAttr {ObjectName}, <TOPLINE | LEFTCOLUMN>, {value}

SetAutoFileRequester -- SetAutoFileRequester {Logical = ON | OFF}

SetAutoLoadFlags -- SetAutoLoadFlags <CHIP | ASNEEDED>

SetBrushAnimFlags -- SetBrushAnimFlags {BufferName}, <mode> [,{PlayTicks}]

where <mode> is:

COMPRESSEDMODE

DECOMPRESSEDMODE

NONE

USEMASK

NOMASK

LEAVEIMAGE

RESTOREBACKGROUND

FORWARD

BACKWARD

PINGPONG

LINEARMOTION

SEQUENCEDMOTION

ASYNC

SYNC

----------------------

SetBusyPointer -- SetBusyPointer [{BrushBuffer} [,{XHotSpot}, {YHotSpot}]

SetChannel -- SetChannel {0 | 1 | 2 | 3}

SetClipTransparentColor -- SetClipTransparentColor {ColorReg}

SetCurrentDirectory -- SetCurrentDirectory {PathName}

SetDBObjects -- SetDBObjects <RecordVar> .Fields | .Buttons | .Lists | .Integers

SetDefaultTool -- SetDefaultTool {IconBufferName}, {ToolString}

SetDrawMode -- SetDrawMode <NORMAL | JAM1 | JAM2 | COMPLEMENT | INVERSEVIDEO>

SetEffect -- SetEffect <CONTROL | SLICES | SCALESTEPS>, {Argument1} [,{Argument2}]

SetExpression -- SetExpression <DEGREES | RADIANS>

SetFileBufferSize -- SetFileBufferSize {KiloBytes}

SetFileRequestMode <REGULARMODE | SAVEFILEMODE | MULTISELECTMODE>, <NONE, FILTERDRAWERS, DRAWERSONLY, REJECTICONS, PATTERNFIELD>

SetFileRequestPattern -- SetFileRequestPattern {Initial}[,{Accept}[,{Reject}]]

SetIconHighlight {IconBufferName}, <COMPLEMENT | BACKFILL | ALTIMAGE> [,{AltBrushBufferName}]

SetIconImage -- SetIconImage {IconBufferName}, {BrushBufferName}[,{AltBrushBufferName}]

SetInsertedLineColors -- SetInsertedLineColors {foreground}, {altforeground}

SetInteger -- SetInteger {ObjectName}, {Integer}

SetLineAttribute -- SetLineAttribute <COLOR>, {color}[, {number of lines}]

SetObjectState -- SetObjectState {ObjectName}, {Logical}

SetPen -- SetPen {PenAColorReg} [,{PenBColorReg} [,{PenOColorReg}]]

SetPointer -- SetPointer [{BrushBufferName} [,{XHotSpot}, {YHotSpot}]]

SetPrintFont -- SetPrintFont {FontName}, {PointSize}

SetPrintStyle <PLAIN | ITALIC | BOLD | UNDERLINE | SHADOW | OUTLINE | GHOSTED | EMBOSSED> [,{ExtraPen1} [,{ExtraPen2}]]

SetPromotion -- SetPromotion ON | OFF

SetPropPosition -- SetPropPosition {ObjectName}, {HorizPos} [,{VertPos}]

SetPropRange -- SetPropRange {ObjectName}, {LowHoriz}, {HighHoriz}[,{LowVert}, {HighVert}]

SetPropVisibleRange -- SetPropVisibleRange {ObjectName}, {DisplayHoriz}[,{DisplayVert}]

SetRGB -- SetRGB {ColorReg}, {RedValue}, {GreenValue}, {BlueValue}

SetScreenTitle -- SetScreenTitle {String}

SetSearchArrayFlags <NOCASE | FORWARD | BACKWARD | SUBSTRING | SUPERSTRING>

SetSongTempo -- SetSongTempo {tempo = 10 -> 60}

SetSongVolume -- SetSongVolume {volume = 0 -> 64}

SetStandardOut -- SetStandardOut {FileWriteBufferName}

SetSystemRequesterTo -- SetSystemRequesterTo <WINDOW | WORKBENCH | NOWHERE>

SetText -- SetText {ObjectName},{String}

SetToolTypeList -- SetToolTypeList {IconBufferName}, {DocumentBufferName}

SetViewOffset -- SetViewOffset {X}, {Y}

SetVolume -- SetVolume {Volume = 0 -> 64} [,{Channel = 0 -> 3}]

SetWindowBrushAnimTPS -- SetWindowBrushAnimTPS {TicksPerSecond = 1 -> 60}

SetWindowLimits -- SetWindowLimits {MinWidth}, {MinHeight},{MaxWidth}, {MaxHeight}

SetWindowTitle -- SetWindowTitle {String}

SetWordDelimiters -- SetWordDelimiters {WordDelimiters}

ShowBrush {BrushBufferName}, {X}, {Y} [,<BRUSHPALETTE | PICTUREPALETTE> [,{MinTermValue (Mod 64)}]]

ShowBrushAnim -- ShowBrushAnim {BAnimBufferName}, {XCoor}, {YCoor}[,{NTimes}]

ShowBrushEfx -- ShowBrushEfx {buffer}, {dx}, {dy}, {efx}, {speed}[, {dw}, {dh}[, {sx}, {sy}, {sw}, {sh}]]

ShowPalette -- ShowPalette {PaletteBufferName}

ShowPaletteEfx -- ShowPaletteEfx {Efx}, {Duration} [, {Buffer}]

ShowPicture -- ShowPicture {PictureBufferName}

Sign -- Integer = Sign({Value}) ;1 if > 0, 0 if 0, -1 if < 0.

Sin -- Value = Sin({Angle})

SinH -- Value = SinH({Value})

SizeOfDocument -- NumberChars = SizeOfDocument

Song -- Song <NEXT | PREVIOUS | CONTINUE | PAUSE | PLAYFASTER | PLAYSLOWER | PLAYNORMALLY>

SortArray <ArrayVar>, <STRING | INTEGER | REAL | NOCASE | ASCENDING | DESCENDING> [,{KeyString}]

SortDocument -- SortDocument <NOCASE | ASCENDING | DESCENDING> [,{StartingColumn}]

SpeakTo -- SpeakTo {ARexxPortName}

SplitLine -- SplitLine [{Count}]

SquareRoot -- RealValue = SquareRoot({Value})

StartedFromWorkbench -- Logical = StartedFromWorkbench

Static -- Static <VarName1>[={value1}] [,<VarName2>[={value2}] ...]

StopScript -- StopScript [{Result}]

String -- String = String({Expression})

Supervised -- Logical = Supervised

SystemControl -<KILLREQ | CDREBOOT | CDREBOOTDEFAULT | CDADDCREATEKEY | CDREMCREATEKEY> [, {Value}]

Tan -- Value = Tan({Angle})

TanH -- Value = TanH({Value})

TextFrom -- String = TextFrom({ObjectName})

TextFromDocument -- String = TextFromDocument({DocumentName})

TheCharacter -- String = TheCharacter

TheColumnNumber -- Integer = TheColumnNumber

TheCommandLine -- Logical = TheCommandLine

TheCurrentDirectory -- PathName = TheCurrentDirectory

TheDate -- String = TheDate ;String = "mm/dd/yy"

TheDrawMode -- String = TheDrawMode

TheLine -- String = TheLine

TheLineNumber -- Integer = TheLineNumber

TheMessage -- String = TheMessage

TheOriginDirectory -- Name = TheOriginDirectory

TheTime -- String = TheTime ;String = HH:MM:SS

TheWord -- String = TheWord

TheWordDelimiters -- String = TheWordDelimiters

TimeLeftOnChannel -- Integer = TimeLeftOnChannel({Channel = 0 -> 3})

TotalAllocatedMemory -- Integer = TotalAllocatedMemory

Transparent -- Transparent {Logical}

TransparentStatus -- Logical = TransparentStatus

TrimString -- String = TrimString({String})

True -- LogicalValue := True

Type -- Type {String} [,<NewLine>]

UnlockPalette -- UnlockPalette [{FirstCol}[, {LastCol}]]

Until -- Until {LogicalExpression}

UnusedAllocatedMemory -- Integer = UnusedAllocatedMemory

UpperCase -- String = UpperCase({String})

UseColoredLines -- UseColoredLines {boolean = ON | OFF}

UsingColoredLines -- Boolean = UsingColoredLines

ValidReal -- Logical = ValidReal({Real})

VarType -- String = VarType(<Var>)

VerifyExpression -- Logical = VerifyExpression({String})

While -- While {LogicalExpression}

Whole -- IntegerValue = Whole({Expression})

WindowTo -- WindowTo <BACK | FRONT>

WindowAddress -- Integer = WindowAddress

WindowBorderBottom -- Integer = WindowBorderBottom

WindowBorderLeft -- Integer = WindowBorderLeft

WindowBorderRight -- Integer = WindowBorderRight

WindowBorderTop -- Integer = WindowBorderTop

WindowColors -- Integer = WindowColors

WindowHeight -- Integer = WindowHeight

WindowName -- String = WindowName

WindowOnFrontScreen -- Boolean = WindowOnFrontScreen

WindowTitle -- String = WindowTitle

WindowWidth -- Integer = WindowWidth

WindowX -- Integer = WindowX

WindowY -- Integer = WindowY

WorkbenchColors -- Integer = WorkbenchColors

WorkbenchHeight -- Integer = WorkbenchHeight

WorkbenchWidth -- Integer = WorkbenchWidth

WorkWithDocument -- WorkWithDocument {DocumentBufferName}

Yes -- Logical = Yes


Home Page, Favorite Links, CanDo! page, C Programming page

James T. Steichen (jimbot at frontiernet.net)
Date Last Modified: 17-Nov-2006