Unit 'AmigaDOS' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#morphunits]

Reference for unit 'AmigaDOS': Procedures and functions

AbortPkt

  

Aborts an asynchronous packet, if possible.

AddBuffers

  

Changes the number of buffers for a filesystem

AddDosEntry

  

Add a Dos List entry to the lists

AddPart

  

Appends a file/dir to the end of a path

AddSegment

  

Adds a resident segment to the resident list

AddSegmentTagList

  

Adds a program segment to the system resident list.

AllocDosObject

  

Creates a dos object

AllocDosObjectTagList

  

VarArgs version of AllocDosObject

AllocDosObjectTags

  

Variable args version for AllocDosObject for direct tag use.

AssignAdd

  

Adds a lock to an assign for multi-directory assigns

AssignLate

  

Creates an assignment to a specified path later

AssignLock

  

Creates an assignment to a locked object

AssignPath

  

Creates an assignment to a specified path

AttemptLockDosList

  

Attempt to lock the Dos Lists for use

BADDR

  

Convert a BPTR to a Pointer

ChangeMode

  

Change the current mode of a lock or filehandle

CheckSignal

  

Checks for break signals

Cli

  

Returns a pointer to the CLI structure of the process

CliInitNewcli

  

Set up a process to be a shell using a startup packet.

CliInitRun

  

Set up a process to be a shell from initial packet

CompareDates

  

Compares two datestamps

CreateNewProc

  

Create a new process from taglist

CreateNewProcTagList

  

CreateNewProcTags

  

Variable args version for CreateNewProc for direct tag use.

CreateProc

  

Create a new process

CurrentDir

  

Make a directory lock the current directory

DateStamp

  

Fills the structure with the current time. Time is measured from 1. Jan. 1978.

DeleteVar

  

Deletes a local or environment variable

DeviceProc

  

Return the process MsgPort of specific I/O handler

DoPkt

  

Send a dos packet and wait for reply

DoPkt0

  

DoPkt1

  

DoPkt2

  

DoPkt3

  

DoPkt4

  

dosClose

  

dosCreateDir

  

Creates a new directory under the given name.

DOSDateToStr

  

DOSDelay

  

Delay a process for a specified time

dosDeleteFile

  

Delete a file or directory

dosExit

  

Instantly terminate the program.

dosFlush

  

Flushes buffers for a buffered filehandle

dosInput

  

Identify the program's initial input file handle

dosOpen

  

Open a file for input or output

dosOutput

  

Identify the programs' initial output file handle

dosRead

  

Read bytes of data from a file

dosReadLn

  

dosRename

  

Rename a directory or file

dosSeek

  

Set the current position for reading and writing

DOSStrToDate

  

dosSystem

  

dosWrite

  

Write bytes of data to a file

dosWriteStr

  

DupLock

  

Duplicate a lock

DupLockFromFH

  

Gets a lock on an open file

EndNotify

  

Ends a notification request

ErrorReport

  

Displays a Retry/Cancel requester for an error

ExAll

  

Examine an entire directory

ExAllEnd

  

Stop an ExAll()

Examine

  

Examine a directory or file associated with a lock

Examine64

  

Fill in a FileInfoBlock structure concerning a file or directory associated with a particular lock.

Examine64TagList

  

VarArgs version of Examine64

Examine64Tags

  

VarArgs Version of Examine64

ExamineFH

  

Gets information on an open file

ExamineFH64

  

Fill in a FileInfoBlock structure concerning a file associated with a particular filehandle.

ExamineFH64TagList

  

VarArgs Version of ExamineFH64

ExamineFH64Tags

  

VarArgs Version of ExamineFH64

Execute

  

Execute a CLI command

ExNext

  

Examine the next entry in a directory

ExNext64

  

Examine the next entry in a directory.

ExNext64TagList

  

VarArgs Version of ExNext64

ExNext64Tags

  

VarArgs Version of ExNext64

Fault

  

Returns the text associated with a DOS error code

FGetC

  

Read a character from the specified input (buffered)

FGets

  

Reads a line from the specified input (buffered)

FilePart

  

Returns the last component of a path

FindArg

  

Find a keyword in a template

FindCliProc

  

Returns a pointer to the requested CLI process

FindDosEntry

  

Finds a specific Dos List entry

FindSegment

  

Finds a segment on the resident list

FindSegmentTagList

  

Search for a resident segment by name and type.

FindVar

  

Finds a local variable

Format

  

Initialise a filesystem for use by the system.

FPutC

  

Write a character to the specified output

FPuts

  

Writes a string the the specified output

FRead

  

Reads a number of blocks from an input (buffered)

FreeArgs

  

Free allocated memory after ReadArgs()

FreeCLIData

  

FreeDeviceProc

  

Releases port returned by GetDeviceProc()

FreeDosEntry

  

Frees an entry created by MakeDosEntry

FreeDosObject

  

Frees an object allocated by AllocDosObject()

FWrite

  

Writes a number of blocks to an output (buffered)

GetArgStr

  

Returns the arguments for the process

GetConsoleTask

  

Returns the default console for the process

GetCurrentDirName

  

Returns the current directory name

GetDeviceProc

  

Finds a handler to send a message to

GetDosObjectAttr

  

GetDosObjectAttrTagList

  

GetFileSysAttr

  

Query filesystem for attributes, such as maximum filename length, or maximum file size.

GetFileSysTask

  

Returns the default filesystem for the process

GetProgramDir

  

Returns a lock on the directory the program was loaded from

GetProgramName

  

Returns the current program name

GetPrompt

  

Returns the prompt for the current process

GetSegListAttr

  

Query seglist for attributes, such as the ObjData ptr.

GetSegListAttrTagList

  

VarArgs Version of GetSegListAttr

GetSegListAttrTags

  

VarArgs Version of GetSegListAttrTagList

GetVar

  

Returns the value of a local or global variable

Info

  

Returns information about the disk

Inhibit

  

Inhibits access to a filesystem

InternalLoadSeg

  

Low-level load routine

IoErr

  

Return extra information from the system

IsFileSystem

  

Returns whether a Dos handler is a filesystem

IsInteractive

  

Discover whether a file is "interactive"

LoadSeg

  

Scatterload a loadable file into memory

Lock

  

Lock a directory or file

LockDosList

  

Locks the specified Dos Lists for use

LockRecord

  

Locks a portion of a file

LockRecord64

  

Lock a portion of a file for exclusive access.

LockRecords

  

Lock a series of records

LockRecords64

  

Lock several records at the same time.

MakeDosEntry

  

Creates a DosList structure

MakeLink

  

Creates a filesystem link

MatchEnd

  

Free storage allocated for MatchFirst()/MatchNext()

MatchFirst

  

Finds file that matches pattern

MatchNext

  

Finds the next file or directory that matches pattern

MatchPattern

  

Checks for a pattern match with a string

MatchPatternNoCase

  

Checks for a pattern match with a string

MaxCli

  

Returns the highest CLI process number possibly in use

MKBADDR

  

Conbert a Pointer to a BPTR Value

NameFromFH

  

Get the name of an open filehandle

NameFromLock

  

Returns the name of a locked object

NewLoadSeg

  

Improved version of LoadSeg for stacksizes

NewLoadSegTagList

  

NewReadLink

  

Read the filename referred to by the soft-linked object

NextDosEntry

  

Get the next Dos List entry

OpenFromLock

  

Opens a file you have a lock on

ParentDir

  

ParentOfFH

  

Returns a lock on the parent directory of a file

ParsePattern

  

Create a tokenized string for MatchPattern()

ParsePatternNoCase

  

Create a tokenized string for MatchPatternNoCase()

PathPart

  

Returns a pointer to the end of the next-to-last component of a path.

PrintFault

  

Returns the text associated with a DOS error code

PutStr

  

Writes a string the the default output (buffered)

QueryCLIDataTagList

  

QueryCLIDataTags

  

VarArgsVersion of QueryCLIDataTagList

ReadArgs

  

Read bytes of data from a file

ReadChar

  

ReadChars

  

ReadItem

  

Reads a single argument/name from command line

ReadLink

  

Reads the path for a soft filesystem link

Relabel

  

Change the volume name of a volume

ReleaseCLINumber

  

RemAssignList

  

Remove an entry from a multi-dir assign

RemDosEntry

  

Removes a Dos List entry from it's list

RemSegment

  

Removes a resident segment from the resident list

ReplyPkt

  

Replies a packet to the person who sent it to you

RunCommand

  

Runs a program using the current process

SameDevice

  

Are two locks are on partitions of the device?

SameLock

  

Returns whether two locks are on the same object

Seek64

  

Changes the current read/write position in a file

SelectInput

  

Select a filehandle as the default input channel

SelectOutput

  

Select a filehandle as the default output channel

SendPkt

  

Sends a packet to a handler

SetArgStr

  

Sets the arguments for the current process

SetComment

  

Change a files' comment string

SetConsoleTask

  

ets the default console for the process

SetCurrentDirName

  

Sets the directory name for the process

SetDosObjectAttr

  

SetDosObjectAttrTagList

  

SetFileDate

  

Sets the modification date for a file or dir

SetFileSize

  

Sets the size of a file

SetFileSize64

  

Change the size of a file.

SetFileSysTask

  

Sets the default filesystem for the process

SetIoErr

  

Sets the value returned by IoErr()

SetMode

  

Set the current behavior of a handler

SetOwner

  

Set owner information for a file or directory

SetProgramDir

  

Sets the directory returned by GetProgramDir

SetProgramName

  

Sets the name of the program being run

SetPrompt

  

Sets the CLI/shell prompt for the current process

SetProtection

  

Set protection for a file or directory

SetVar

  

Sets a local or environment variable

SetVBuf

  

Set buffering modes and size

SplitName

  

splits out a component of a pathname into a buffer

StartNotify

  

Starts notification on a file or directory

StrToLong

  

string to Integer value (decimal)

SystemTagList

  

Have a shell execute a command line

SystemTags

  

Variable args version for SystemTagList for direct tag use.

UnGetC

  

Makes a char available for reading again. (buffered)

UnLoadSeg

  

Unload a seglist previously loaded by LoadSeg()

Unlock

  

Unlock a directory or file

UnLockDosList

  

Unlocks the Dos List

UnLockRecord

  

Unlock a record

UnLockRecord64

  

Release a lock made with LockRecord64().

UnLockRecords

  

Unlock a list of records

UnLockRecords64

  

Release an array of record locks obtained with LockRecords64().

UnReadChar

  

VFPrintf

  

format and print a string to a file (buffered)

VFWritef

  

Write a BCPL formatted string to a file (buffered)

VPrintf

  

Format and print string (buffered)

VWritef

  

WaitForChar

  

Determine if chars arrive within a time limit

WaitPkt

  

Waits for a packet to arrive at your pr_MsgPort

WriteChar

  

WriteChars

  

Writes bytes to the the default output (buffered)


Documentation generated on: 2021-07-30