Control Program Functions: Difference between revisions
mNo edit summary |
|||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 49: | Line 49: | ||
*[[DosScanEnv]] - Gets information for a file or subdirectory | *[[DosScanEnv]] - Gets information for a file or subdirectory | ||
*[[DosSearchPath]] - Scans environment variable | *[[DosSearchPath]] - Scans environment variable | ||
*DosQueryPathInfo - Searches along a specified path | *[[DosQueryPathInfo]] - Searches along a specified path | ||
*DosSetPathInfo - Sets information for a file or subdirectory | *[[DosSetPathInfo]] - Sets information for a file or subdirectory | ||
===Extended LIBPATH Search Path Functions=== | ===Extended LIBPATH Search Path Functions=== | ||
| Line 66: | Line 66: | ||
*[[DosSubAllocMem]] - Suballocates a block of memory from a heap that was previously initialized | *[[DosSubAllocMem]] - Suballocates a block of memory from a heap that was previously initialized | ||
*[[DosSubFreeMem]] - Frees a block of memory that was previously suballocated | *[[DosSubFreeMem]] - Frees a block of memory that was previously suballocated | ||
*[[DosSubSetMem]] - Initializes a heap for suballocation, or | *[[DosSubSetMem]] - Initializes a heap for suballocation, or increases the size of a previously initialized heap | ||
*[[DosSubUnsetMem]] - Terminates the use of a heap | *[[DosSubUnsetMem]] - Terminates the use of a heap | ||
| Line 99: | Line 99: | ||
===Session Control Functions=== | ===Session Control Functions=== | ||
*[[DosSelectSession]] | *[[DosSelectSession]] - Selects a child session | ||
*[[DosSetSession]] - Sets the status of a child session | *[[DosSetSession]] - Sets the status of a child session | ||
*[[DosStartSession]] - Starts an unrelated or child session | *[[DosStartSession]] - Starts an unrelated or child session | ||
| Line 199: | Line 199: | ||
==Message Management Functions== | ==Message Management Functions== | ||
*[[DosGetMessage]] | *[[DosGetMessage]] - Retrieves a message from a message file | ||
*[[DosInsertMessage]] | *[[DosInsertMessage]] - Inserts variable text into message | ||
*[[DosPutMessage]] - Sends a message to an output file or device | *[[DosPutMessage]] - Sends a message to an output file or device | ||
*[[DosQueryMessageCP]] - Retrieves a message file list of code pages and language identifiers | *[[DosQueryMessageCP]] - Retrieves a message file list of code pages and language identifiers | ||
| Line 227: | Line 227: | ||
==Dos...== | ==Dos...== | ||
===Unsorted=== | ===Unsorted=== | ||
*[[DosAliasMem | *[[DosAliasMem]] | ||
*[[DosQueryMemState | *[[DosQueryMemState]] | ||
*[[DosListIO]] | *[[DosListIO]] | ||
*[[DosQueryAppType]] | *[[DosQueryAppType]] | ||
| Line 251: | Line 238: | ||
*[[DosGetDateTime]] | *[[DosGetDateTime]] | ||
*[[DosSetDateTime]] | *[[DosSetDateTime]] | ||
===Timer=== | |||
*[[DosTmrQueryFreq]] | *[[DosTmrQueryFreq]] | ||
*[[DosTmrQueryTime]] | *[[DosTmrQueryTime]] | ||
| Line 256: | Line 245: | ||
=== Error Management === | === Error Management === | ||
*[[DosSuppressPopUps]] | *[[DosSuppressPopUps]] | ||
*[[DosDumpProcess | *[[DosDumpProcess]] | ||
*[[DosForceSystemDump | *[[DosForceSystemDump]] | ||
*[[Dos16SysTrace | *[[Dos16SysTrace]] | ||
=== Exception Management === | === Exception Management === | ||
*[[DosQueryModFromEIP]] [[ | *[[DosQueryModFromEIP]] | ||
*[[ | *[[Dos16QueryModFromCS]] | ||
===Large File System=== | |||
*[[DosCancelLockRequestL]] | |||
*[[DosListIOL]] - Performs the specified number of seek/read or seek/write operations | |||
*[[DosOpenL]] - Opens a file | |||
*[[DosProtectOpenL]] - Opens a file returning a protected file handle | |||
*[[DosProtectSetFileLocksL]] - Locks and unlocks a range of an open file | |||
*[[DosProtectSetFilePtrL]] - Moves the read or write pointer | |||
*[[DosProtectSetFileSizeL]] - Changes the size of a file | |||
*[[DosSetFileLocksL]] - Locks and unlocks a range of an open file | |||
*[[DosSetFilePtrL]] - Moves the read or write pointer | |||
*[[DosSetFileSizeL]] - Changes the size of a file | |||
==== File Manipulation ==== | ==== File Manipulation ==== | ||
*[[DosCancelLockRequest]] | *[[DosCancelLockRequest]] | ||
| Line 270: | Line 270: | ||
*[[DosForceDelete]] | *[[DosForceDelete]] | ||
*[[DosProtectOpen]] | *[[DosProtectOpen]] | ||
*[[DosReplaceModule | *[[DosReplaceModule]] | ||
*[[DosProtectRead]] | *[[DosProtectRead]] | ||
*[[DosProtectSetFileInfo]] | *[[DosProtectSetFileInfo]] | ||
| Line 319: | Line 319: | ||
*[[DosOpenVDD]] | *[[DosOpenVDD]] | ||
*[[DosRequestVDD]] | *[[DosRequestVDD]] | ||
==Kbd, Mou, Vio== | ==Kbd, Mou, Vio== | ||
| Line 414: | Line 413: | ||
*[[VioShowPS]] | *[[VioShowPS]] | ||
== | == OS/2 1.x Functions == | ||
Function calls for OS/2 1.x that offer compatibility with DOS via [[Family API]] or Windows NT OS/2 subsystem. | |||
===Dos=== | |||
=== Date / Time === | ====Date/Time==== | ||
*[[DosGetDateTime ( | *[[DosGetDateTime (OS/2 1.x)|DosGetDateTime]] | ||
*[[DosSetDateTime ( | *[[DosSetDateTime (OS/2 1.x)|DosSetDateTime]] | ||
=== Device I/O === | ====Device I/O==== | ||
*[[DosBeep ( | *[[DosBeep (OS/2 1.x)|DosBeep]] | ||
*[[DosDevConfig ( | *[[DosDevConfig (OS/2 1.x)|DosDevConfig]] | ||
*[[DosDevIOCtl (FAPI)|DosDevIOCtl]] | *[[DosDevIOCtl (FAPI)|DosDevIOCtl]] | ||
*[[DosDevIOCtl2]] | *[[DosDevIOCtl2]] | ||
*[[DosPhysicalDisk (FAPI)|DosPhysicalDisk]] | *[[DosPhysicalDisk (FAPI)|DosPhysicalDisk]] | ||
=== Dynamic Linking Library === | ====Dynamic Linking Library==== | ||
*[[DosFreeModule (OS/2 1.x)|DosFreeModule]] | |||
*[[DosGetModHandle]] | *[[DosGetModHandle]] | ||
*[[DosGetModName]] | *[[DosGetModName]] | ||
*[[DosLoadModule (OS/2 1.x)|DosLoadModule]] | |||
*[[DosQAppType]] | |||
==== Monitor functions ==== | ====Monitor functions==== | ||
*[[DosMonClose]] | *[[DosMonClose]] | ||
*[[DosMonOpen]] | *[[DosMonOpen]] | ||
| Line 440: | Line 442: | ||
*[[DosMonWrite]] | *[[DosMonWrite]] | ||
= | ====Error Management==== | ||
=== Error Management === | |||
*[[DosErrClass (FAPI)|DosErrClass]] | *[[DosErrClass (FAPI)|DosErrClass]] | ||
*[[DosError (FAPI)|DosError]] | *[[DosError (FAPI)|DosError]] | ||
| Line 454: | Line 451: | ||
*[[DosLogRead]] | *[[DosLogRead]] | ||
===Exception Management=== | ====Exception Management==== | ||
*[[DosHoldSignal]] | |||
*[[DosSendSignal]] | *[[DosSendSignal]] | ||
*[[DosSetSigHandler]] | |||
=== File Systems/File Management === | ====File Systems/File Management==== | ||
Directory Searching: | |||
*[[DosFindClose]] | |||
*[[DosFindFirst (FAPI)|DosFindFirst]] | *[[DosFindFirst (FAPI)|DosFindFirst]] | ||
*[[DosFindFirst2]] | *[[DosFindFirst2]] | ||
*[[DosFindNext (FAPI)|DosFindNext]] | *[[DosFindNext (FAPI)|DosFindNext]] | ||
Directory Handling: | |||
*[[DosChDir]] | *[[DosChDir]] | ||
*[[DosMkDir]] | *[[DosMkDir]] | ||
| Line 474: | Line 474: | ||
*[[DosSelectDisk]] | *[[DosSelectDisk]] | ||
==== Environment/Path ==== | ====Environment/Path==== | ||
*[[DosScanEnv (OS/2 1.x)|DosScanEnv]] | *[[DosScanEnv (OS/2 1.x)|DosScanEnv]] | ||
*[[DosSearchPath (OS/2 1.x)|DosSearchPath]] | *[[DosSearchPath (OS/2 1.x)|DosSearchPath]] | ||
==== File Manipulation==== | ====File Manipulation==== | ||
*[[DosChgFilePtr]] | *[[DosChgFilePtr]] | ||
*[[DosClose (FAPI)|DosClose]] | *[[DosClose (FAPI)|DosClose]] | ||
| Line 489: | Line 489: | ||
*[[DosOpen2]] | *[[DosOpen2]] | ||
*[[DosRead (FAPI)|DosRead]] | *[[DosRead (FAPI)|DosRead]] | ||
*[[DosReadAsync]] | |||
*[[DosSetFileInfo (FAPI)|DosSetFileInfo]] | *[[DosSetFileInfo (FAPI)|DosSetFileInfo]] | ||
*[[DosSetPathInfo (OS/2 1.x)|DosSetPathInfo]] | *[[DosSetPathInfo (OS/2 1.x)|DosSetPathInfo]] | ||
*[[DosSetVerify (FAPI)|DosSetVerify]] | *[[DosSetVerify (FAPI)|DosSetVerify]] | ||
*[[DosWrite (FAPI)|DosWrite]] | *[[DosWrite (FAPI)|DosWrite]] | ||
*[[DosWriteAsync]] | |||
*[[DosNewSize]] | *[[DosNewSize]] | ||
*[[DosSetFileMode]] | *[[DosSetFileMode]] | ||
==== File Handle Manipulation ==== | ====File Handle Manipulation==== | ||
*[[DosSetMaxFH (OS/2 1.x)|DosSetMaxFH]] | *[[DosSetMaxFH (OS/2 1.x)|DosSetMaxFH]] | ||
*[[DosBufReset]] | *[[DosBufReset]] | ||
| Line 503: | Line 505: | ||
*[[DosSetFHandState]] | *[[DosSetFHandState]] | ||
==== File Querying ==== | ====File Querying==== | ||
*[[DosEnumAttribute (OS/2 1.x)|DosEnumAttribute]] | *[[DosEnumAttribute (OS/2 1.x)|DosEnumAttribute]] | ||
*[[DosQFileInfo]] | *[[DosQFileInfo]] | ||
| Line 511: | Line 513: | ||
*[[DosQVerify]] | *[[DosQVerify]] | ||
==== File System Functions==== | ====File System Functions==== | ||
*[[DosFSAttach (OS/2 1.x)|DosFSAttach]] | *[[DosFSAttach (OS/2 1.x)|DosFSAttach]] | ||
*[[DosFSCtl (OS/2 1.x)|DosFSCtl]] | *[[DosFSCtl (OS/2 1.x)|DosFSCtl]] | ||
| Line 519: | Line 521: | ||
*[[DosQFSInfo]] | *[[DosQFSInfo]] | ||
=== Memory Management === | ====Memory Management==== | ||
*[[DosAllocSeg]] | *[[DosAllocSeg]] | ||
*[[DosAllocShrSeg]] | *[[DosAllocShrSeg]] | ||
*[[DosFreeSeg]] | *[[DosFreeSeg]] | ||
*[[DosGetSeg]] | *[[DosGetSeg]] | ||
*[[DosGetShrSeg]] | |||
*[[DosGiveSeg]] | *[[DosGiveSeg]] | ||
*[[DosLockSeg]] | *[[DosLockSeg]] | ||
| Line 531: | Line 532: | ||
*[[DosSizeSeg]] | *[[DosSizeSeg]] | ||
*[[DosUnlockSeg]] | *[[DosUnlockSeg]] | ||
*[[DosReallocSeg]] | |||
;Huge block | |||
*[[DosAllocHuge]] | |||
*[[DosReallocHuge]] | *[[DosReallocHuge]] | ||
;Heap | |||
*[[DosSubAlloc]] | |||
*[[DosSubFree]] | *[[DosSubFree]] | ||
*[[DosSubSet]] | *[[DosSubSet]] | ||
=== Message Management === | ====Message Management==== | ||
*[[DosGetMessage (OS/2 1.x)|DosGetMessage]] | *[[DosGetMessage (OS/2 1.x)|DosGetMessage]] | ||
*[[DosPutMessage (FAPI)|DosPutMessage]] | *[[DosPutMessage (FAPI)|DosPutMessage]] | ||
*[[DosInsMessage]] | *[[DosInsMessage]] | ||
*[[DosTrueGetMessage | *[[DosTrueGetMessage]] | ||
*[[DosIQueryMessageCP | *[[DosIQueryMessageCP]] | ||
*[[DosCloseMessageFile | *[[DosCloseMessageFile]] | ||
=== National Language/Code Page === | ====National Language/Code Page==== | ||
*[[DosCaseMap (FAPI)|DosCaseMap]] | *[[DosCaseMap (FAPI)|DosCaseMap]] | ||
*[[DosGetCollate]] | *[[DosGetCollate]] | ||
| Line 555: | Line 560: | ||
*[[DosSetProcCp]] | *[[DosSetProcCp]] | ||
====Named Pipes==== | ====Named Pipes==== | ||
*[[ | *[[DosCallNmPipe]] - | ||
*[[ | *[[DosConnectNmPipe]] - enables named pipe to be opened | ||
*[[ | *[[DosDisConnectNmPipe]] | ||
*[[DosMakeNmPipe]] | *[[DosMakeNmPipe]] | ||
*[[DosMakePipe]] | *[[DosMakePipe]] | ||
*[[ | *[[DosPeekNmPipe]] | ||
*[[ | *[[DosQNmPipeInfo]] | ||
*[[DosQNmPipeSemState | *[[DosQNmPipeSemState]] | ||
*[[ | *[[DosQNmPHandState]] | ||
*[[ | *[[DosRawReadNPipe]] | ||
*[[ | *[[DosRawWriteNPipe]] | ||
*[[ | *[[DosSetNmPHandState]] | ||
*[[ | *[[DosSetNmPipeSem]] | ||
*[[DosTransactNmPipe]] | |||
*[[DosWaitNmPipe]] | |||
=== Resource Management === | ====Resource Management==== | ||
*[[DosFreeResource (OS/2 1.x)|DosFreeResource]] | *[[DosFreeResource (OS/2 1.x)|DosFreeResource]] | ||
*[[DosGetResource (OS/2 1.x)|DosGetResource]] | *[[DosGetResource (OS/2 1.x)|DosGetResource]] | ||
*[[DosGetResource2]] | *[[DosGetResource2]] | ||
=== Semaphores === | ====Semaphores==== | ||
*[[DosCloseSem]] | *[[DosCloseSem]] | ||
*[[DosCreateSem]] | *[[DosCreateSem]] | ||
| Line 589: | Line 595: | ||
*[[DosPMSemWait]] | *[[DosPMSemWait]] | ||
==== MuxWait Semaphores ==== | ====MuxWait Semaphores==== | ||
*[[DosMuxSemWait]] | *[[DosMuxSemWait]] | ||
*[[DosPMMuxSemWait]] | *[[DosPMMuxSemWait]] | ||
=== Processes/Threading === | ====Processes/Threading==== | ||
*[[DosCallback]] | |||
*[[DosExit (FAPI)|DosExit]] | *[[DosExit (FAPI)|DosExit]] | ||
*[[DosGetPrty]] | |||
*[[DosSetPrty]] | *[[DosSetPrty]] | ||
==== Processes ==== | ====Processes==== | ||
*[[DosCWait]] | |||
*[[DosEnterCritSec (OS/2 1.x)|DosEnterCritSec]] | *[[DosEnterCritSec (OS/2 1.x)|DosEnterCritSec]] | ||
*[[DosExitCritSec (OS/2 1.x)|DosExitCritSec]] | *[[DosExitCritSec (OS/2 1.x)|DosExitCritSec]] | ||
*[[DosExitList (OS/2 1.x)|DosExitList]] | *[[DosExitList (OS/2 1.x)|DosExitList]] | ||
*[[ | *[[DosExecPgm (FAPI)|DosExecPgm]] | ||
*[[ | *[[DosFlagProcess]] | ||
*[[DosGetInfoSeg]] | |||
*[[DosGetPID]] | *[[DosGetPID]] | ||
*[[DosGetPPID]] | *[[DosGetPPID]] | ||
*[[ | *[[DosKillProcess (OS/2 1.x)|DosKillProcess]] | ||
=== Session Management=== | ====Session Management==== | ||
*[[DosSelectSession (OS/2 1.x)|DosSelectSession]] | *[[DosSelectSession (OS/2 1.x)|DosSelectSession]] | ||
*[[DosSetSession (OS/2 1.x)|DosSetSession]] | *[[DosSetSession (OS/2 1.x)|DosSetSession]] | ||
| Line 614: | Line 623: | ||
*[[DosStopSession (OS/2 1.x)|DosStopSession]] | *[[DosStopSession (OS/2 1.x)|DosStopSession]] | ||
;Session Manager | |||
*[[DosSMDoAppReq]] | |||
*[[DosSMGetAppReq]] | |||
*[[DosSMGetStatus]] | |||
*[[DosSMHDEInit]] | |||
*[[DosSMInitialize]] | |||
*[[DosSMNotifyDD]] | |||
*[[DosSMNotifyDD2]] | |||
*[[DosSMOpenDD]] | |||
*[[DosSMParentSwitch]] | |||
*[[DosSMPause]] | |||
*[[DosSMPMPresent]] | |||
*DosSMRealPrtSc | |||
*[[DosSMRegisterDD]] | |||
*[[DosSMServeAppReq]] | |||
*[[DosSMSetSessionType]] | |||
*[[DosSMSetTitle]] | |||
*[[DosSMStart]] | |||
*[[DosSMSwitch]] | |||
*[[DosSMSysInit]] | |||
*[[DosSMTerminate]] | |||
;Screen Group | |||
*[[DosSMSGDoPopup]] | *[[DosSMSGDoPopup]] | ||
*[[DosSMSGEndPopup]] | *[[DosSMSGEndPopup]] | ||
*[[DosGetTimes]] | *[[DosGetTimes]] | ||
*[[DosScrUnlock]] | *[[DosScrUnlock]] | ||
*[[DosScrLock]] | *[[DosScrLock]] | ||
*[[DosSavRedrawWait]] | *[[DosSavRedrawWait]] | ||
| Line 629: | Line 656: | ||
*[[DosSetMNLockTime]] | *[[DosSetMNLockTime]] | ||
*[[DosModeUndo]] | *[[DosModeUndo]] | ||
*[[DosModeWait]] | *[[DosModeWait]] | ||
*[[DosRegisterNotification]] | *[[DosRegisterNotification]] | ||
=== | ====Timer==== | ||
== | |||
*[[DosTimerAsync]] | *[[DosTimerAsync]] | ||
*[[DosTimerStart]] | *[[DosTimerStart]] | ||
*[[DosTimerStop]] | *[[DosTimerStop]] | ||
=== Addressing === | ====Addressing==== | ||
*[[DosFlatToSel | *[[DosFlatToSel]] | ||
*[[DosSelToFlat | *[[DosSelToFlat]] | ||
=== Spool === | ====Spool==== | ||
''Not found on OS2TK45'' | ''Not found on OS2TK45'' | ||
*[[DosPFSActivate]] | *[[DosPFSActivate]] | ||
| Line 669: | Line 676: | ||
*[[DosPFSVerifyFont]] | *[[DosPFSVerifyFont]] | ||
=== | ====I/O Privileges==== | ||
*[[DosCLIAccess]] | *[[DosCLIAccess]] | ||
*[[DosPortAccess]] | |||
====Segments==== | |||
*[[DosCreateCSAlias]] | *[[DosCreateCSAlias]] | ||
*[[DosFileIO]] | *[[DosFileIO]] | ||
*[[DosGetEnv]] | *[[DosGetEnv]] | ||
*[[DosGetHugeShift]] | *[[DosGetHugeShift]] | ||
| Line 681: | Line 690: | ||
*[[DosGetProcAddr]] | *[[DosGetProcAddr]] | ||
*[[DosGetVersion]] | *[[DosGetVersion]] | ||
*[[DosR2StackRealloc]] | *[[DosR2StackRealloc]] | ||
*[[DosSetVec]] | *[[DosSetVec]] | ||
*[[DosSysCtl]] | *[[DosSysCtl]] | ||
*[[DosQueryRASInfo]] | *[[DosQueryRASInfo]] | ||
=== Keyboard functions === | ====QuickHelp==== | ||
* [[KbdCharIn]] | *[[QhKeybdHandle]] | ||
* [[ | *[[QhMouseHandle]] | ||
* [[ | |||
* [[ | ===Keyboard functions=== | ||
* [[ | *[[KbdCharIn]] - character data record from keyboard | ||
* [[ | *[[KbdClose]] - closes logical keyboard | ||
* [[ | *[[KbdDeRegister]] - deregister keyboard subsystem | ||
* [[ | *[[KbdFlushBuffer]] - | ||
* [[ | *[[KbdFreeFocus]] | ||
* [[ | *[[KbdGetCp]] | ||
* [[ | *[[KbdGetFocus]] - | ||
* [[ | *[[KbdGetHWId]] | ||
* [[ | *[[KbdGetStatus]] - | ||
* [[ | *[[KbdInit]] - | ||
* [[ | *[[KbdOpen]] - | ||
* [[ | *[[KbdPeek]] - | ||
* [[ | *[[KbdRegister]] | ||
* [[KbdSetStatus]] | *[[KbdSetCp]] | ||
* [[ | *[[KbdSetCustXt]] | ||
* [[ | *[[KbdSetFgnd]] | ||
* [[ | *[[KbdSetHWID]] | ||
*[[KbdSetStatus]] | |||
*[[KbdSynch]] - | |||
*[[KbdStringIn]] | |||
*[[KbdXlate]] | |||
===Mouse functions=== | |||
*[[MouRegister]] | *[[MouRegister]] | ||
*[[MouDeRegister]] | *[[MouDeRegister]] | ||
| Line 736: | Line 740: | ||
*[[MouGetNumMickeys (OS/2 1.x)|MouGetNumMickeys]] | *[[MouGetNumMickeys (OS/2 1.x)|MouGetNumMickeys]] | ||
*[[MouGetNumQueEl (OS/2 1.x)|MouGetNumQueEl]] | *[[MouGetNumQueEl (OS/2 1.x)|MouGetNumQueEl]] | ||
* [[MouGetPtrPos]] | *[[MouGetPtrPos]] | ||
*[[MouGetPtrShape (OS/2 1.x)|MouGetPtrShape]] | *[[MouGetPtrShape (OS/2 1.x)|MouGetPtrShape]] | ||
*[[MouGetScaleFact (OS/2 1.x)|MouGetScaleFact]] | *[[MouGetScaleFact (OS/2 1.x)|MouGetScaleFact]] | ||
| Line 751: | Line 755: | ||
*[[MouFree]] | *[[MouFree]] | ||
===Video I/O functions=== | |||
* [[ | *[[VioCheckCharType]] | ||
* [[ | *[[VioDeRegister]] | ||
* [[ | *[[VioEndPopUp]] | ||
* [[ | *[[VioGetAnsi]] | ||
* [[ | *[[VioGetBuf]] | ||
* [[ | *[[VioGetConfig]] | ||
* [[ | *[[VioGetCp]] | ||
* [[ | *[[VioGetCurPos]] | ||
* [[ | *[[VioGetCurType]] | ||
* [[ | *[[VioGetFont]] | ||
* [[ | *[[VioGetMode]] | ||
* [[ | *[[VioGetPhysBuf]] | ||
* [[ | *[[VioGetState]] | ||
* [[ | *[[VioGlobalReg]] | ||
* [[ | *[[VioModeUndo]] | ||
* [[ | *[[VioModeWait]] | ||
* [[ | *[[VioPopUp]] | ||
* [[ | *[[VioPrtSc]] | ||
* [[ | *[[VioPrtScToggle]] | ||
* [[ | *[[VioQueryConsole]] | ||
* [[ | *[[VioReadCellStr]] | ||
* [[ | *[[VioReadCharStr]] | ||
* [[ | *[[VioRedrawSize]] | ||
* [[ | *[[VioRegister]] | ||
* [[ | *[[VioSavRedrawUndo]] | ||
* [[ | *[[VioSavRedrawWait]] | ||
* [[ | *[[VioSetFont]] | ||
* [[ | *[[VioScrLock]] | ||
* [[ | *[[VioScrollDn]] | ||
* [[ | *[[VioScrollLf]] | ||
* [[ | *[[VioScrollRt]] | ||
* [[ | *[[VioScrollUp]] | ||
* [[ | *[[VioScrUnLock]] | ||
* [[ | *[[VioSetAnsi]] | ||
* [[ | *[[VioSetCp]] | ||
* [[ | *[[VioSetCurPos]] | ||
* [[ | *[[VioSetCurType]] | ||
* [[ | *[[VioSetMode]] | ||
* [[VioShowBuf|VioShowBuf]] | *[[VioSetState]] | ||
* [[VioWrtCellStr|VioWrtCellStr]] | *[[VioShowBuf (FAPI)|VioShowBuf]] | ||
* [[VioWrtCharStr|VioWrtCharStr]] | *[[VioWrtCellStr (FAPI)|VioWrtCellStr]] | ||
* [[VioWrtCharStrAtt|VioWrtCharStrAtt]] | *[[VioWrtCharStr (FAPI)|VioWrtCharStr]] | ||
* [[VioWrtNAttr|VioWrtNAttr]] | *[[VioWrtCharStrAtt (FAPI)|VioWrtCharStrAtt]] | ||
* [[VioWrtNCell|VioWrtNCell]] | *[[VioWrtNAttr (FAPI)|VioWrtNAttr]] | ||
* [[VioWrtNChar|VioWrtNChar]] | *[[VioWrtNCell (FAPI)|VioWrtNCell]] | ||
* [[VioWrtTTY|VioWrtTTY]] | *[[VioWrtNChar (FAPI)|VioWrtNChar]] | ||
*[[VioWrtTTY (FAPI)|VioWrtTTY]] | |||
==References== | ==References== | ||
* IBM OS/2 Programming Reference | |||
* IBM OS/2 Warp [[Control Program Programming Guide and Reference]] (1996) | |||
* IBM API Addendum Volume 1 (PowerPC Edition) | |||
[[Category:The OS/2 API Project]] | [[Category:The OS/2 API Project]] | ||
Latest revision as of 23:10, 30 April 2023
Some general information is available at Control Program page.
File Management
File Functions
- DosClose - Closes a file handle
- DosCopy - Copies a file or subdirectory
- DosDelete - Deletes a file
- DosEditName - Transforms a file name
- DosMove - Moves a file or subdirectory
- DosOpen - Gets a handle to a file, pipe, or device
- DosRead - Reads from a file, pipe, or device
- DosSetFileInfo - Sets information for an open file
- DosSetFileLocks - Locks and unlocks a range in a file
- DosSetFilePtr - Moves the position of the file pointer
- DosSetFileSize - Changes the size of a file
- DosSetPathInfo - Sets information for a file or subdirectory
- DosSetVerify - Enables write verification
- DosWrite - Writes data to a file, pipe, or device
File Handle Functions
- DosDupHandle - Duplicates a file handle
- DosQueryFHState - Gets the file handle state
- DosQueryHType - Gets the handle type
- DosSetFHState - Sets the file handle state
- DosSetMaxFH - Sets the maximum number of file handles
File Query Functions
- DosEnumAttribute - Gets the name and size of a file object's extended attributes
- DosQueryFileInfo - Gets information for an open file
- DosQueryPathInfo - Gets information for a file or subdirectory
- DosQuerySysInfo - Gets values of system variables
- DosQueryVerify - Determines whether or not write verification is enabled
Directory Search (FileFind) Functions
- DosFindClose - Ends a search for matching file objects
- DosFindFirst - Begins a search for matching file objects
- DosFindNext - Continues a search for matching file objects
Directory and Disk Functions
- DosCreateDir - Creates a subdirectory
- DosDeleteDir - Deletes an empty subdirectory
- DosQueryCurrentDir - Gets the current directory
- DosQueryCurrentDisk - Gets the current drive
- DosSetCurrentDir - Sets the current directory
- DosSetDefaultDisk - Sets the default drive
Environment and Search Path Functions
- DosScanEnv - Gets information for a file or subdirectory
- DosSearchPath - Scans environment variable
- DosQueryPathInfo - Searches along a specified path
- DosSetPathInfo - Sets information for a file or subdirectory
Extended LIBPATH Search Path Functions
- DosQueryExtLIBPATH - Queries the search path for Dynamic Link Library, which is either before or after LIBPATH search
- DosSetExtLIBPATH - Sets a search path for Dynamic Link Library, either before or after LIBPATH search
Memory Management
Memory Functions
- DosAllocMem - Allocates a private memory object within the virtual address space
- DosFreeMem - Frees a private or shared memory object from the virtual address space of the process
- DosQueryMem - Obtains information about a range of pages within the virtual address space of the subject process
- DosSetMem - Commits or decommits a range of pages within a memory object, or alters their protection
Memory Suballocation Functions
- DosSubAllocMem - Suballocates a block of memory from a heap that was previously initialized
- DosSubFreeMem - Frees a block of memory that was previously suballocated
- DosSubSetMem - Initializes a heap for suballocation, or increases the size of a previously initialized heap
- DosSubUnsetMem - Terminates the use of a heap
- DosAllocSharedMem - Allocates a shared memory object within the virtual address space
- DosGetNamedSharedMem - Obtains access to an existing named shared memory object
- DosGetSharedMem - Obtains access to an existing shared memory object
- DosGiveSharedMem - Gives a target process access to an existing shared memory object
Thread Local Memory Functions
- DosAllocThreadLocalMemory - Allocates a block of memory that is unique, or local, to a thread
- DosFreeThreadLocalMemory - Frees a block of thread-local memory
Program Execution Control
Thread Control Functions
- DosCreateThread
- DosEnterCritSec
- DosExit - Terminates thread execution in the current process
- DosExitCritSec - Enables thread switching for the current process
- DosGetInfoBlocks
- DosKillThread
- DosResumeThread
- DosSetPriority
- DosSuspendThread
- DosWaitThread
Process Control Functions
- DosExecPgm - Executes another program as a child process
- DosExitList - Defines a list of routines to be executed when the current process ends
- DosKillProcess
- DosWaitChild - Waits for a child process to end
Session Control Functions
- DosSelectSession - Selects a child session
- DosSetSession - Sets the status of a child session
- DosStartSession - Starts an unrelated or child session
- DosStopSession - Terminates one or all child sessions
Semaphore Functions
Event Semaphore Functions
- DosCloseEventSem - Closes an event semaphore
- DosCreateEventSem - Creates an event semaphore
- DosOpenEventSem - Opens an event semaphore for use
- DosPostEventSem - Posts an event semaphore
- DosQueryEventSem
- DosResetEventSem - Resets an event semaphore
- DosWaitEventSem
Mutex Semaphore Functions
- DosCloseMutexSem
- DosCreateMutexSem
- DosOpenMutexSem
- DosQueryMutexSem
- DosReleaseMutexSem
- DosRequestMutexSem
Muxwait Semaphore Functions
- DosAddMuxWaitSem
- DosCloseMuxWaitSem
- DosCreateMuxWaitSem
- DosDeleteMuxWaitSem
- DosOpenMuxWaitSem
- DosQueryMuxWaitSem
- DosWaitMuxWaitSem - Waits for a muxwait semaphore to clear
Pipe Functions
Named-Pipe Functions
- DosCallNPipe
- DosConnectNPipe
- DosCreateNPipe - Creates a named pipe
- DosDisConnectNPipe
- DosPeekNPipe
- DosQueryNPHState
- DosQueryNPipeInfo
- DosQueryNPipeSemState
- DosSetNPHState - Resets the blocking mode and the read mode of a named pipe
- DosSetNPipeSem - Attaches a shared event semaphore to a local named pipe
- DosTransactNPipe - Writes to a duplex message pipe, then reads from it
- DosWaitNPipe - Waits for an instance of a named pipe to become available
Unnamed-Pipe Functions
- DosClose - Closes a file or pipe
- DosCreatePipe - Creates an unnamed (anonymous) pipe
- DosDupHandle, DosOpen, DosRead, DosWrite
Queue Functions
- DosCloseQueue - Closes a queue
- DosCreateQueue - Creates a queue
- DosOpenQueue - Opens a queue
- DosPeekQueue
- DosPurgeQueue
- DosQueryQueue - Returns the number of elements in a queue
- DosReadQueue
- DosWriteQueue - Writes an element to a queue
Timer Functions
- DosAsyncTimer
- DosSleep - Suspends the current thread for a specified time interval
- DosStartTimer
- DosStopTimer
Error Management Functions
- DosErrClass
- DosError - Disables and enables hard-error and exception pop-up messages
Exception Handling Functions
- DosRaiseException - Raises an exception
- DosSetExceptionHandler - Registers an exception handler
- DosUnsetExceptionHandler
- DosUnwindException
Signal Exception Functions
- DosAcknowledgeSignalException
- DosSendSignalException
- DosSetSignalExceptionFocus - Sets keyboard signal focus
Must-Complete Functions
- DosEnterMustComplete - Enters a must-complete section of code
- DosExitMustComplete - Exits a must-complete section of code
Device I/O Functions
File System Functions Used to Perform I/O to Devices:
- DosClose
- DosOpen
- DosRead
- DosWrite
Message Management Functions
- DosGetMessage - Retrieves a message from a message file
- DosInsertMessage - Inserts variable text into message
- DosPutMessage - Sends a message to an output file or device
- DosQueryMessageCP - Retrieves a message file list of code pages and language identifiers
Code Page Management Functions
Code Page Functions
- DosQueryCp
- DosSetProcessCp - Sets the code page of a process
Country Dependent Functions
- DosMapCase
- DosQueryCollate
- DosQueryCtryInfo
- DosQueryDBCSEnv
- DosQueryMessageCP
Debugging Functions
- DosDebug - Used by one process to control another for debugging purposes
Dynamic Linking Functions
- DosFreeModule - Frees the reference to the dynamic link module for the process
- DosLoadModule - Loads a dynamic link module, and returns a handle for the module
- DosQueryModuleHandle
- DosQueryModuleName
- DosQueryProcAddr - Returns the address of the specified procedure within a dynamic link module
Dos...
Unsorted
Date/Time
Timer
Error Management
Exception Management
Large File System
- DosCancelLockRequestL
- DosListIOL - Performs the specified number of seek/read or seek/write operations
- DosOpenL - Opens a file
- DosProtectOpenL - Opens a file returning a protected file handle
- DosProtectSetFileLocksL - Locks and unlocks a range of an open file
- DosProtectSetFilePtrL - Moves the read or write pointer
- DosProtectSetFileSizeL - Changes the size of a file
- DosSetFileLocksL - Locks and unlocks a range of an open file
- DosSetFilePtrL - Moves the read or write pointer
- DosSetFileSizeL - Changes the size of a file
File Manipulation
- DosCancelLockRequest
- DosProtectClose
- DosForceDelete
- DosProtectOpen
- DosReplaceModule
- DosProtectRead
- DosProtectSetFileInfo
- DosProtectSetFileLocks
- DosProtectSetFilePtr
- DosProtectSetFileSize
- DosProtectWrite
File Handle Manipulation
File Querying
- DosProtectEnumAttribute
- DosQueryFileMode
- DosProtectQueryFileInfo
- DosQuerySysState
- DosPerfSysCall
- DosGetProcessorStatus
- DosSetProcessorStatus
- DosQueryABIOSSupport
File System Functions
Resource Management
Threads
VDD
Kbd, Mou, Vio
Keyboard functions
- KbdCharIn
- KbdGetConsole
- KbdPeek
- KbdStringIn
- KbdFlushBuffer
- KbdSetStatus
- KbdGetStatus
- KbdSetCp
- KbdGetCp
- KbdGetLayout
- KbdGetLayoutUni
- KbdSetLayout
- KbdSetLayoutUni
- KbdGetHWID
- KbdXlate
Mouse functions
- MouFlushQue
- MouGetPtrPos
- MouSetPtrPos
- MouSetPtrShape
- MouGetPtrShape
- MouGetDevStatus
- MouGetNumButtons
- MouGetNumMickeys
- MouReadEventQue
- MouGetNumQueEl
- MouGetEventMask
- MouSetEventMask
- MouGetScaleFact
- MouSetScaleFact
- MouRemovePtr
- MouDrawPtr
- MouSetDevStatus
- MouGetThreshold
- MouSetThreshold
Video I/O functions
- VioGetBuf
- VioGetCurPos
- VioSetCurPos
- VioGetCurType
- VioSetCurType
- VioGetMode
- VioSetMode
- VioReadCellStr
- VioReadCharStr
- VioWrtCellStr
- VioWrtCharStr
- VioScrollUp
- VioScrollDown
- VioScrollLeft
- VioScrollRight
- VioWrtNAttr
- VioWrtNCell
- VioWrtNChar
- VioWrtTTY
- VioWrtCharStrAtt
- VioShowBuf
- VioSetAnsi
- VioGetAnsi
- VioSavRedrawWait
- VioSavRedrawUndo
- VioModeWait
- VioModeUndo
- VioScrLock
- VioScrUnLock
- VioPopUp
- VioEndPopUp
- VioGetConfig
- VioGetCp
- VioSetCp
- VioGetOrigin
- VioSetOrigin
- VioGetState
- VioSetState
Advanced VIO
- VioAssociate
- VioCreateLogFont
- VioCreatePS
- VioDeleteSetId
- VioDestroyPS
- VioGetDeviceCellSize
- VioQueryFonts
- VioQuerySetIds
- VioSetDeviceCellSize
- VioShowPS
OS/2 1.x Functions
Function calls for OS/2 1.x that offer compatibility with DOS via Family API or Windows NT OS/2 subsystem.
Dos
Date/Time
Device I/O
Dynamic Linking Library
Monitor functions
Error Management
OS/2 2.0 and 1.3 only:
Exception Management
File Systems/File Management
Directory Searching:
Directory Handling:
Disk
Environment/Path
File Manipulation
- DosChgFilePtr
- DosClose
- DosCopy
- DosDelete
- DosEditName
- DosFileLocks
- DosMove
- DosOpen
- DosOpen2
- DosRead
- DosReadAsync
- DosSetFileInfo
- DosSetPathInfo
- DosSetVerify
- DosWrite
- DosWriteAsync
- DosNewSize
- DosSetFileMode
File Handle Manipulation
File Querying
File System Functions
Memory Management
- DosAllocSeg
- DosAllocShrSeg
- DosFreeSeg
- DosGetSeg
- DosGetShrSeg
- DosGiveSeg
- DosLockSeg
- DosMemAvail
- DosSizeSeg
- DosUnlockSeg
- DosReallocSeg
- Huge block
- Heap
Message Management
National Language/Code Page
Named Pipes
- DosCallNmPipe -
- DosConnectNmPipe - enables named pipe to be opened
- DosDisConnectNmPipe
- DosMakeNmPipe
- DosMakePipe
- DosPeekNmPipe
- DosQNmPipeInfo
- DosQNmPipeSemState
- DosQNmPHandState
- DosRawReadNPipe
- DosRawWriteNPipe
- DosSetNmPHandState
- DosSetNmPipeSem
- DosTransactNmPipe
- DosWaitNmPipe
Resource Management
Semaphores
- DosCloseSem
- DosCreateSem
- DosFSRamSemClear
- DosFSRamSemRequest
- DosOpenSem
- DosSemClear
- DosSemRequest
- DosSemSet
- DosSemSetWait
- DosSemWait
- DosPMSemWait
MuxWait Semaphores
Processes/Threading
Processes
- DosCWait
- DosEnterCritSec
- DosExitCritSec
- DosExitList
- DosExecPgm
- DosFlagProcess
- DosGetInfoSeg
- DosGetPID
- DosGetPPID
- DosKillProcess
Session Management
- Session Manager
- DosSMDoAppReq
- DosSMGetAppReq
- DosSMGetStatus
- DosSMHDEInit
- DosSMInitialize
- DosSMNotifyDD
- DosSMNotifyDD2
- DosSMOpenDD
- DosSMParentSwitch
- DosSMPause
- DosSMPMPresent
- DosSMRealPrtSc
- DosSMRegisterDD
- DosSMServeAppReq
- DosSMSetSessionType
- DosSMSetTitle
- DosSMStart
- DosSMSwitch
- DosSMSysInit
- DosSMTerminate
- Screen Group
- DosGetTimes
- DosScrUnlock
- DosScrLock
- DosSavRedrawWait
- DosSavRedrawUndo
- DosSetMNLockTime
- DosModeUndo
- DosModeWait
- DosRegisterNotification
Timer
Addressing
Spool
Not found on OS2TK45
I/O Privileges
Segments
QuickHelp
Keyboard functions
- KbdCharIn - character data record from keyboard
- KbdClose - closes logical keyboard
- KbdDeRegister - deregister keyboard subsystem
- KbdFlushBuffer -
- KbdFreeFocus
- KbdGetCp
- KbdGetFocus -
- KbdGetHWId
- KbdGetStatus -
- KbdInit -
- KbdOpen -
- KbdPeek -
- KbdRegister
- KbdSetCp
- KbdSetCustXt
- KbdSetFgnd
- KbdSetHWID
- KbdSetStatus
- KbdSynch -
- KbdStringIn
- KbdXlate
Mouse functions
- MouRegister
- MouDeRegister
- MouOpen
- MouClose
- MouInitReal
- MouSynch
- MouDrawPtr
- MouFlushQue
- MouGetDevStatus
- MouGetEventMask
- MouGetNumButtons
- MouGetNumMickeys
- MouGetNumQueEl
- MouGetPtrPos
- MouGetPtrShape
- MouGetScaleFact
- MouReadEventQue
- MouRemovePtr
- MouSetDevStatus
- MouSetEventMask
- MouSetPtrPos
- MouSetPtrShape
- MouSetScaleFact
- MouShellInit
- MouGetHotKey
- MouSetHotKey
- MouFree
Video I/O functions
- VioCheckCharType
- VioDeRegister
- VioEndPopUp
- VioGetAnsi
- VioGetBuf
- VioGetConfig
- VioGetCp
- VioGetCurPos
- VioGetCurType
- VioGetFont
- VioGetMode
- VioGetPhysBuf
- VioGetState
- VioGlobalReg
- VioModeUndo
- VioModeWait
- VioPopUp
- VioPrtSc
- VioPrtScToggle
- VioQueryConsole
- VioReadCellStr
- VioReadCharStr
- VioRedrawSize
- VioRegister
- VioSavRedrawUndo
- VioSavRedrawWait
- VioSetFont
- VioScrLock
- VioScrollDn
- VioScrollLf
- VioScrollRt
- VioScrollUp
- VioScrUnLock
- VioSetAnsi
- VioSetCp
- VioSetCurPos
- VioSetCurType
- VioSetMode
- VioSetState
- VioShowBuf
- VioWrtCellStr
- VioWrtCharStr
- VioWrtCharStrAtt
- VioWrtNAttr
- VioWrtNCell
- VioWrtNChar
- VioWrtTTY
References
- IBM OS/2 Programming Reference
- IBM OS/2 Warp Control Program Programming Guide and Reference (1996)
- IBM API Addendum Volume 1 (PowerPC Edition)