Jump to content

Control Program Functions: Difference between revisions

From EDM2
← Older edit
Ak120 (talk | contribs)
35,819 edits
 
(14 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 increases the size of a previously initialized heap
*[[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...==
===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
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
===Unsorted===
===Unsorted===
*[[DosAliasMem]] [[Image:Conf.gif]]
*[[DosAliasMem]]
*[[DosQueryMemState]] [[Image:Conf.gif]]
*[[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]]  [[Image:Conf.gif]]
*[[DosDumpProcess]]
*[[DosForceSystemDump]] [[Image:Conf.gif]]
*[[DosForceSystemDump]]
*[[Dos16SysTrace]] [[Image:Conf.gif]]
*[[Dos16SysTrace]]


=== Exception Management ===
=== Exception Management ===
*[[DosQueryModFromEIP]] [[Image:Conf.gif]]
*[[DosQueryModFromEIP]]
*[[Dos16QueryModFromCS]] [[Image:Conf.gif]]
*[[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 Systems/File Management ===
==== File Manipulation ====
==== File Manipulation ====
*[[DosCancelLockRequest]]
*[[DosCancelLockRequest]]
Line 270: Line 270:
*[[DosForceDelete]]
*[[DosForceDelete]]
*[[DosProtectOpen]]
*[[DosProtectOpen]]
*[[DosReplaceModule]] [[Image:Conf.gif]]
*[[DosReplaceModule]]
*[[DosProtectRead]]
*[[DosProtectRead]]
*[[DosProtectSetFileInfo]]
*[[DosProtectSetFileInfo]]
Line 286: Line 286:
==== File Querying ====
==== File Querying ====
*[[DosProtectEnumAttribute]]
*[[DosProtectEnumAttribute]]
*[[DosQueryFileMode]] [[image:Att.gif]] [[image:Vraag.gif]]
*[[DosQueryFileMode]]
*[[DosProtectQueryFileInfo]]
*[[DosProtectQueryFileInfo]]
*[[DosQuerySysState]] [[Image:Conf.gif]]
*[[DosQuerySysState]]
*[[DosPerfSysCall]]
*[[DosPerfSysCall]]
*[[DosGetProcessorStatus]] [[Image:Conf.gif]]
*[[DosGetProcessorStatus]]
*[[DosSetProcessorStatus]] [[Image:Conf.gif]]
*[[DosSetProcessorStatus]]
*[[DosQueryABIOSSupport]] [[Image:Conf.gif]]
*[[DosQueryABIOSSupport]]


==== File System Functions ====
==== File System Functions ====
Line 309: Line 309:


==== Threads ====
==== Threads ====
*[[DosCreateThread2]] [[Image:Conf.gif]]
*[[DosCreateThread2]]
*[[DosQueryThreadAffinity]] [[Image:Conf.gif]]
*[[DosQueryThreadAffinity]]
*[[DosQueryThreadContext]]
*[[DosQueryThreadContext]]
*[[DosSetThreadAffinity]] [[Image:Conf.gif]]
*[[DosSetThreadAffinity]]
*[[DosVerifyPidTid]] [[Image:Conf.gif]]
*[[DosVerifyPidTid]]


=== VDD ===
=== VDD ===
Line 319: Line 319:
*[[DosOpenVDD]]
*[[DosOpenVDD]]
*[[DosRequestVDD]]
*[[DosRequestVDD]]
</div>


==Kbd, Mou, Vio==
==Kbd, Mou, Vio==
Line 373: Line 372:
*[[VioWrtCellStr]]
*[[VioWrtCellStr]]
*[[VioWrtCharStr]]
*[[VioWrtCharStr]]
*[[VioScrollUp]] [[image:Att.gif]]
*[[VioScrollUp]]
*[[VioScrollDown]] [[image:Att.gif]]
*[[VioScrollDown]]
*[[VioScrollLeft]] [[image:Att.gif]]
*[[VioScrollLeft]]
*[[VioScrollRight]] [[image:Att.gif]]
*[[VioScrollRight]]
*[[VioWrtNAttr]]
*[[VioWrtNAttr]]
*[[VioWrtNCell]]
*[[VioWrtNCell]]
Line 414: Line 413:
*[[VioShowPS]]
*[[VioShowPS]]


=== Icon Legend===
== OS/2 1.x Functions ==
* [[image:Att.gif]]: It seems that these functions were not implemented on the OS/2 4.5 Toolkit.
Function calls for OS/2 1.x that offer compatibility with DOS via [[Family API]] or Windows NT OS/2 subsystem.
* [[Image:Conf.gif]]: These functions were documented on the Addendum of the OS/2 4.5 Toolkit.
* [[image:Vraag.gif]]: More information is required on this function.


== Legacy Functions ==
===Dos===
This are the legacy functions of the Control Program Interface API. This functions are supposed to be replaced by the newer ones, but some of these are still required for older programs to work or because some newer functions weren't implemented correctly.  
====Date/Time====
*[[DosGetDateTime (OS/2 1.x)|DosGetDateTime]]
*[[DosSetDateTime (OS/2 1.x)|DosSetDateTime]]


<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
====Device I/O====
=== Date / Time ===
*[[DosBeep (OS/2 1.x)|DosBeep]]
* [[DosGetDateTime (Legacy)|DosGetDateTime]]
*[[DosDevConfig (OS/2 1.x)|DosDevConfig]]
* [[DosSetDateTime (Legacy)|DosSetDateTime]]
*[[DosDevIOCtl (FAPI)|DosDevIOCtl]]
*[[DosDevIOCtl2]]
*[[DosPhysicalDisk (FAPI)|DosPhysicalDisk]]


=== Device I/O ===
====Dynamic Linking Library====
* [[DosBeep (Legacy)|DosBeep]]
*[[DosFreeModule (OS/2 1.x)|DosFreeModule]]
* [[DosDevConfig|DosDevConfig]]
*[[DosGetModHandle]]
* [[DosDevIOCtl|DosDevIOCtl]]
*[[DosGetModName]]
* [[DosDevIOCtl2|DosDevIOCtl2]]
*[[DosLoadModule (OS/2 1.x)|DosLoadModule]]
* [[DosPhysicalDisk|DosPhysicalDisk]]
*[[DosQAppType]]


=== Dynamic Linking Library ===  
====Monitor functions====
* [[DosGetModHandle|DosGetModHandle]]
*[[DosMonClose]]
* [[DosGetModName|DosGetModName]]
*[[DosMonOpen]]
*[[DosMonRead]]
*[[DosMonReg]]
*[[DosMonWrite]]


==== Monitor functions ====
====Error Management====
* [[DosMonClose|DosMonClose]]
*[[DosErrClass (FAPI)|DosErrClass]]
* [[DosMonOpen|DosMonOpen]]
*[[DosError (FAPI)|DosError]]
* [[DosMonRead|DosMonRead]]
*[[DosPTrace]]
* [[DosMonReg|DosMonReg]]
OS/2 2.0 and 1.3 only:
* [[DosMonWrite|DosMonWrite]]
*[[DosLogRegister]]
*[[DosLogEntry]]
*[[DosLogRead]]


=== Dynamic Link Library ===
====Exception Management====
* [[DosFreeModule|DosFreeModule]]
*[[DosHoldSignal]]
* [[DosLoadModule|DosLoadModule]]
*[[DosSendSignal]]
* [[DosQAppType|DosQAppType]]
*[[DosSetSigHandler]]


=== Error Management ===
====File Systems/File Management====
* [[DosErrClass|DosErrClass]]
Directory Searching:
* [[DosError|DosError]]
*[[DosFindClose]]
* [[DosPTrace]]
*[[DosFindFirst (FAPI)|DosFindFirst]]
* [[DosLogRegister|DosLogRegister]] *  (OS/2 2.0 and 1.3)
*[[DosFindFirst2]]
* [[DosLogEntry|DosLogEntry]] *  (OS/2 2.0 and 1.3)
*[[DosFindNext (FAPI)|DosFindNext]]
* [[DosLogRead|DosLogRead]] * (OS/2 2.0 and 1.3)


===Exception Management===
Directory Handling:
* [[DosSendSignal|DosSendSignal]]
*[[DosChDir]]
*[[DosMkDir]]
*[[DosMkDir2]]
*[[DosRmDir]]
*[[DosQCurDir]]


=== File Systems/File Management ===
====Disk====
==== Directory Searching ====
*[[DosQCurDisk]]
* [[DosFindFirst]]
*[[DosSelectDisk]]
* [[DosFindFirst2]]
* [[DosFindNext]]
 
====Directory====
* [[DosChDir]]
* [[DosMkDir]]
* [[DosMkDir2|DosMkDir2]]
* [[DosRmDir|DosRmDir]]
* [[DosQCurDir|DosQCurDir]]


====Disk====
====Environment/Path====
* [[DosQCurDisk|DosQCurDisk]]
*[[DosScanEnv (OS/2 1.x)|DosScanEnv]]
* [[DosSelectDisk|DosSelectDisk]]
*[[DosSearchPath (OS/2 1.x)|DosSearchPath]]


==== Enviroment/Path ====
====File Manipulation====
* [[DosScanEnv|DosScanEnv]]
*[[DosChgFilePtr]]
* [[DosSearchPath|DosSearchPath]]
*[[DosClose (FAPI)|DosClose]]
*[[DosCopy (OS/2 1.x)|DosCopy]]
*[[DosDelete (FAPI)|DosDelete]]
*[[DosEditName (FAPI)|DosEditName]]
*[[DosFileLocks]]
*[[DosMove (FAPI)|DosMove]]
*[[DosOpen (FAPI)|DosOpen]]
*[[DosOpen2]]
*[[DosRead (FAPI)|DosRead]]
*[[DosReadAsync]]
*[[DosSetFileInfo (FAPI)|DosSetFileInfo]]
*[[DosSetPathInfo (OS/2 1.x)|DosSetPathInfo]]
*[[DosSetVerify (FAPI)|DosSetVerify]]
*[[DosWrite (FAPI)|DosWrite]]
*[[DosWriteAsync]]
*[[DosNewSize]]
*[[DosSetFileMode]]


==== File Manipulation====
====File Handle Manipulation====
* [[DosChgFilePtr|DosChgFilePtr]]
*[[DosSetMaxFH (OS/2 1.x)|DosSetMaxFH]]
* [[DosClose|DosClose]]
*[[DosBufReset]]
* [[DosCopy|DosCopy]]
*[[DosQFHandState]]
* [[DosDelete|DosDelete]]
*[[DosQHandType]]
* [[DosEditName|DosEditName]]
*[[DosSetFHandState]]
* [[DosFileLocks|DosFileLocks]]
* [[DosMove|DosMove]]
* [[DosOpen|DosOpen]]
* [[DosOpen2|DosOpen2]]
* [[DosRead|DosRead]]
* [[DosSetFileInfo|DosSetFileInfo]]
* [[DosSetPathInfo|DosSetPathInfo]]
* [[DosSetVerify|DosSetVerify]]
* [[DosWrite|DosWrite]]
* [[DosNewSize|DosNewSize]]
* [[DosSetFileMode|DosSetFileMode]]


==== File Handle Manipulation ====
====File Querying====
* [[DosSetMaxFH|DosSetMaxFH]]
*[[DosEnumAttribute (OS/2 1.x)|DosEnumAttribute]]
* [[DosBufReset|DosBufReset]]
*[[DosQFileInfo]]
* [[DosQFHandState|DosQFHandState]]
*[[DosQFileMode]]
* [[DosQHandType|DosQHandType]]
*[[DosQPathInfo]]
* [[DosSetFHandState|DosSetFHandState]]
*[[DosQSysInfo]]
*[[DosQVerify]]


==== File Querying ====
====File System Functions====
* [[DosEnumAttribute|DosEnumAttribute]]
*[[DosFSAttach (OS/2 1.x)|DosFSAttach]]
* [[DosQFileInfo|DosQFileInfo]]
*[[DosFSCtl (OS/2 1.x)|DosFSCtl]]
* [[DosQFileMode|DosQFileMode]]
*[[DosSetFSInfo (OS/2 1.x)|DosSetFSInfo]]
* [[DosQPathInfo|DosQPathInfo]]
*[[DosShutdown (OS/2 1.x)|DosShutdown]]
* [[DosQSysInfo|DosQSysInfo]]
*[[DosQFSAttach]]
* [[DosQVerify|DosQVerify]]
*[[DosQFSInfo]]


==== File System Functions====
====Memory Management====
* [[DosFSAttach|DosFSAttach]]
*[[DosAllocSeg]]
* [[DosFSCtl|DosFSCtl]]
*[[DosAllocShrSeg]]
* [[DosSetFSInfo|DosSetFSInfo]]
*[[DosFreeSeg]]
* [[DosShutdown|DosShutdown]]
*[[DosGetSeg]]
* [[DosQFSAttach|DosQFSAttach]]
*[[DosGetShrSeg]]
* [[DosQFSInfo|DosQFSInfo]]
*[[DosGiveSeg]]
*[[DosLockSeg]]
*[[DosMemAvail]]
*[[DosSizeSeg]]
*[[DosUnlockSeg]]
*[[DosReallocSeg]]


=== Memory Management ===
;Huge block
* [[DosSubAlloc]]
*[[DosAllocHuge]]
* [[DosAllocSeg]]
*[[DosReallocHuge]]
* [[DosAllocShrSeg]]
* [[DosAllocHuge]]
* [[DosFreeSeg]]
* [[DosGetSeg]]
* [[DosGiveSeg]]
* [[DosLockSeg]]
* [[DosMemAvail]]
* [[DosSizeSeg]]
* [[DosUnlockSeg]]
* [[DosReallocHuge]]
* [[DosReallocSeg]]


==== Heap Memory ====
;Heap
* [[DosSubFree]]
*[[DosSubAlloc]]
* [[DosSubSet]]
*[[DosSubFree]]
*[[DosSubSet]]


=== Message Management ===
====Message Management====
* [[DosGetMessage|DosGetMessage]]
*[[DosGetMessage (OS/2 1.x)|DosGetMessage]]
* [[DosPutMessage|DosPutMessage]]
*[[DosPutMessage (FAPI)|DosPutMessage]]
* [[DosInsMessage|DosInsMessage]]
*[[DosInsMessage]]
* [[DosTrueGetMessage|DosTrueGetMessage]] [[image:Vraag.gif]]
*[[DosTrueGetMessage]]
* [[DosIQueryMessageCP|DosIQueryMessageCP]] [[image:Vraag.gif]]
*[[DosIQueryMessageCP]]
* [[DosCloseMessageFile|DosCloseMessageFile]] [[image:Vraag.gif]]
*[[DosCloseMessageFile]]


=== National Language/Code Page ===
====National Language/Code Page====
* [[DosCaseMap (FAPI)|DosCaseMap]]
*[[DosCaseMap (FAPI)|DosCaseMap]]
* [[DosGetCollate|DosGetCollate]]
*[[DosGetCollate]]
* [[DosGetCp]]
*[[DosGetCp]]
* [[DosGetCtryInfo|DosGetCtryInfo]]
*[[DosGetCtryInfo]]
* [[DosGetDBCSEv|DosGetDBCSEv]]
*[[DosGetDBCSEv]]
* [[DosSetCp|DosSetCp]]
*[[DosSetCp]]
* [[DosSetProcCp|DosSetProcCp]]
*[[DosSetProcCp]]


=== Pipes ===
====Named Pipes====
====Named Pipes====
* [[DosCallNmPipe|DosCallNmPipe]]
*[[DosCallNmPipe]] -
* [[DosConnectNmPipe|DosConnectNmPipe]]
*[[DosConnectNmPipe]] - enables named pipe to be opened
* [[DosDisConnectNmPipe|DosDisConnectNmPipe]]
*[[DosDisConnectNmPipe]]
* [[DosMakeNmPipe|DosMakeNmPipe]]
*[[DosMakeNmPipe]]
* [[DosMakePipe|DosMakePipe]]
*[[DosMakePipe]]
* [[DosPeekNmPipe|DosPeekNmPipe]]
*[[DosPeekNmPipe]]
* [[DosQNmPipeInfo|DosQNmPipeInfo]]
*[[DosQNmPipeInfo]]
* [[DosQNmPipeSemState|DosQNmPipeSemState]]
*[[DosQNmPipeSemState]]
* [[DosSetNmPipeSem|DosSetNmPipeSem]]
*[[DosQNmPHandState]]
* [[DosTransactNmPipe|DosTransactNmPipe]]
*[[DosRawReadNPipe]]
* [[DosWaitNmPipe|DosWaitNmPipe]]
*[[DosRawWriteNPipe]]
* [[DosQNmPHandState|DosQNmPHandState]]
*[[DosSetNmPHandState]]
* [[DosSetNmPHandState|DosSetNmPHandState]]
*[[DosSetNmPipeSem]]
*[[DosTransactNmPipe]]
*[[DosWaitNmPipe]]
 
====Resource Management====
*[[DosFreeResource (OS/2 1.x)|DosFreeResource]]
*[[DosGetResource (OS/2 1.x)|DosGetResource]]
*[[DosGetResource2]]


=== Resource Management ===
====Semaphores====
* [[DosFreeResource|DosFreeResource]]
*[[DosCloseSem]]
* [[DosGetResource|DosGetResource]]
*[[DosCreateSem]]
* [[DosGetResource2|DosGetResource2]]
*[[DosFSRamSemClear]]
*[[DosFSRamSemRequest]]
*[[DosOpenSem]]
*[[DosSemClear]]
*[[DosSemRequest]]
*[[DosSemSet]]
*[[DosSemSetWait]]
*[[DosSemWait]]
*[[DosPMSemWait]]


=== Semaphores ===
====MuxWait Semaphores====
* [[DosCloseSem]]
*[[DosMuxSemWait]]
* [[DosCreateSem]]
*[[DosPMMuxSemWait]]
* [[DosFSRamSemClear]]
* [[DosFSRamSemRequest]]
* [[DosOpenSem]]
* [[DosSemClear]]
* [[DosSemRequest]]
* [[DosSemSet]]
* [[DosSemSetWait]]
* [[DosSemWait]]
* [[DosPMSemWait]]  [[image:Vraag.gif]]
* [[DosPMMuxSemWait]]  [[image:Vraag.gif]]


==== MuxWait Semaphores ====
====Processes/Threading====
* [[DosMuxSemWait]]
*[[DosCallback]]
*[[DosExit (FAPI)|DosExit]]
*[[DosGetPrty]]
*[[DosSetPrty]]


=== Processes/Threading ===
====Processes====
* [[DosExit|DosExit]]
*[[DosCWait]]
* [[DosSetPrty|DosSetPrty]]
*[[DosEnterCritSec (OS/2 1.x)|DosEnterCritSec]]
*[[DosExitCritSec (OS/2 1.x)|DosExitCritSec]]
*[[DosExitList (OS/2 1.x)|DosExitList]]
*[[DosExecPgm (FAPI)|DosExecPgm]]
*[[DosFlagProcess]]
*[[DosGetInfoSeg]]
*[[DosGetPID]]
*[[DosGetPPID]]
*[[DosKillProcess (OS/2 1.x)|DosKillProcess]]


==== Processes ====
====Session Management====
* [[DosEnterCritSec|DosEnterCritSec]]
*[[DosSelectSession (OS/2 1.x)|DosSelectSession]]
* [[DosExecPgm|DosExecPgm]]
*[[DosSetSession (OS/2 1.x)|DosSetSession]]
* [[DosExitCritSec|DosExitCritSec]]
*[[DosStartSession (OS/2 1.x)|DosStartSession]]
* [[DosExitList|DosExitList]]
*[[DosStopSession (OS/2 1.x)|DosStopSession]]
* [[DosKillProcess|DosKillProcess]]
* [[DosCWait]]
* [[DosGetPID|DosGetPID]]
* [[DosGetPPID|DosGetPPID]]
* [[DosGetInfoSeg|DosGetInfoSeg]]


=== Session Management===
;Session Manager
* [[DosSelectSession (OS/2 1.x)|DosSelectSession]]
*[[DosSMDoAppReq]]
* [[DosSetSession (OS/2 1.x)|DosSetSession]]
*[[DosSMGetAppReq]]
* [[DosStartSession (OS/2 1.x)|DosStartSession]]
*[[DosSMGetStatus]]
* [[DosStopSession (OS/2 1.x)|DosStopSession]]
*[[DosSMHDEInit]]
*[[DosSMInitialize]]
*[[DosSMNotifyDD]]
*[[DosSMNotifyDD2]]
*[[DosSMOpenDD]]
*[[DosSMParentSwitch]]
*[[DosSMPause]]
*[[DosSMPMPresent]]
*DosSMRealPrtSc
*[[DosSMRegisterDD]]
*[[DosSMServeAppReq]]
*[[DosSMSetSessionType]]
*[[DosSMSetTitle]]
*[[DosSMStart]]
*[[DosSMSwitch]]
*[[DosSMSysInit]]
*[[DosSMTerminate]]


=== Screen Group ===
;Screen Group
* [[DosSMSGDoPopup]]
*[[DosSMSGDoPopup]]
* [[DosSMSGEndPopup]]
*[[DosSMSGEndPopup]]


* [[DosSMSwitch]]
*[[DosGetTimes]]
* [[DosSMServeAppReq]]
*[[DosScrUnlock]]
* [[DosGetTimes]]
*[[DosScrLock]]
* [[DosSMSetTitle]]
*[[DosSavRedrawWait]]
* [[DosScrUnlock]]
*[[DosSavRedrawUndo]]
* [[DosSMDoAppReq]]
*[[DosSetMNLockTime]]
* [[DosScrLock]]
*[[DosModeUndo]]
* [[DosSavRedrawWait]]
*[[DosModeWait]]
* [[DosSavRedrawUndo]]
*[[DosRegisterNotification]]
* [[DosSetMNLockTime]]
* [[DosModeUndo]]
* [[DosSMGetStatus]]
* [[DosModeWait]]
* [[DosSMTerminate]]
* [[DosSMGetAppReq]]
* DosSMRealPrtSc
* [[DosSMInitialize]]
* [[DosSMStart]]
* [[DosSMParentSwitch]]
* [[DosSMPause]]
* [[DosSMHDEInit]]
* [[DosSMPMPresent]]
* [[DosSMRegisterDD]]
* [[DosSMSysInit]]
* [[DosSMNotifyDD]]
* [[DosSMNotifyDD2]]
* [[DosSMOpenDD]]
* [[DosSMSetSessionType]]
* [[DosRegisterNotification]]


=== Quickhelp ===
====Timer====
* [[QhKeybdHandle]]
*[[DosTimerAsync]]
* [[QhMouseHandle]]
*[[DosTimerStart]]
*[[DosTimerStop]]


=== Timer ===
====Addressing====
* [[DosTimerAsync|DosTimerAsync]]
*[[DosFlatToSel]]
* [[DosTimerStart|DosTimerStart]]
*[[DosSelToFlat]]
* [[DosTimerStop|DosTimerStop]]


=== Addressing ===
====Spool====
* [[DosFlatToSel|DosFlatToSel]] [[image:Vraag.gif]]
''Not found on OS2TK45''
* [[DosSelToFlat|DosSelToFlat]] [[image:Vraag.gif]]
*[[DosPFSActivate]]
*[[DosPFSCloseUser]]
*[[DosPFSInit]]
*[[DosPFSQueryAct]]
*[[DosPFSVerifyFont]]


=== Spool ===
====I/O Privileges====
* [[DosPFSActivate|DosPFSActivate]] * Not found on OS2TK45
*[[DosCLIAccess]]
* [[DosPFSCloseUser|DosPFSCloseUser]] * Not found on OS2TK45
*[[DosPortAccess]]
* [[DosPFSInit|DosPFSInit]] * Not found on OS2TK45
* [[DosPFSQueryAct|DosPFSQueryAct]] * Not found on OS2TK45
* [[DosPFSVerifyFont|DosPFSVerifyFont]] * Not found on OS2TK45


===To SORT===
====Segments====
*[[DosCreateCSAlias]]


* [[DosCallback|DosCallback]]
*[[DosFileIO]]
* [[DosCLIAccess|DosCLIAccess]]
* [[DosCreateCSAlias|DosCreateCSAlias]]
* [[DosFileIO|DosFileIO]]
* [[DosFindClose|DosFindClose]]
* [[DosFlagProcess|DosFlagProcess]]
* [[DosGetEnv|DosGetEnv]]
* [[DosGetHugeShift|DosGetHugeShift]]
* [[DosGetMachineMode|DosGetMachineMode]]


* [[DosGetProcAddr|DosGetProcAddr]]
*[[DosGetEnv]]
* [[DosGetPrty|DosGetPrty]]
*[[DosGetHugeShift]]
* [[DosGetShrSeg|DosGetShrSeg]]
*[[DosGetMachineMode]]
* [[DosGetVersion|DosGetVersion]]
* [[DosHoldSignal|DosHoldSignal]]


* [[DosPortAccess|DosPortAccess]]
*[[DosGetProcAddr]]
* [[DosR2StackRealloc|DosR2StackRealloc]]
* [[DosReadAsync|DosReadAsync]]


* [[DosSetSigHandler|DosSetSigHandler]]
*[[DosGetVersion]]
* [[DosSetVec|DosSetVec]]
* [[DosSMRegisterDD|DosSMRegisterDD]]
* [[DosWriteAsync|DosWriteAsync]]
* [[DosSysCtl]] [[image:Vraag.gif]]
* [[DosQueryRASInfo]] [[image:Vraag.gif]]
* [[DosRawReadNPipe]] [[image:Vraag.gif]]
* [[DosRawWriteNPipe]] [[image:Vraag.gif]]


=== Keyboard functions ===
*[[DosR2StackRealloc]]
* [[KbdCharIn]]
* [[KbdFlushBuffer]]
* [[KbdGetCp]]
* [[KbdSetCp]]
* [[KbdPeek]]
* [[KbdRegister]]
* [[KbdDeRegister]]
* [[KbdOpen]]
* [[KbdClose]]
* [[KbdGetFocus]]
* [[KbdFreeFocus]]
* [[KbdSynch]]
* [[KbdSetFgnd]]
* [[KbdGetHWId]]
* [[KbdSetHWID]] [[image:Vraag.gif]]
* [[KbdSetCustXt]]
* [[KbdGetStatus]]
* [[KbdSetStatus]]
* [[KbdStringIn]]
* [[KbdXlate]]
* [[KbdInit]] [[image:Vraag.gif]]


==== Mouse functions ====
*[[DosSetVec]]
* [[MouRegister|MouRegister]]
*[[DosSysCtl]]
* [[MouDeRegister|MouDeRegister]]
*[[DosQueryRASInfo]]
* [[MouOpen|MouOpen]]
* [[MouClose|MouClose]]
* [[MouInitReal|MouInitReal]]
* [[MouSynch|MouSynch]]
* [[MouDrawPtr|MouDrawPtr]]
* [[MouFlushQue|MouFlushQue]]
* [[MouGetDevStatus|MouGetDevStatus]]
* [[MouGetEventMask|MouGetEventMask]]
* [[MouGetNumButtons|MouGetNumButtons]]
* [[MouGetNumMickeys|MouGetNumMickeys]]
* [[MouGetNumQueEl|MouGetNumQueEl]]
* [[MouGetPtrPos]]
* [[MouGetPtrShape|MouGetPtrShape]]
* [[MouGetScaleFact|MouGetScaleFact]]
* [[MouReadEventQue|MouReadEventQue]]
* [[MouRemovePtr|MouRemovePtr]]
* [[MouSetDevStatus|MouSetDevStatus]]
* [[MouSetEventMask|MouSetEventMask]]
* [[MouSetPtrPos|MouSetPtrPos]]
* [[MouSetPtrShape|MouSetPtrShape]]
* [[MouSetScaleFact|MouSetScaleFact]]
* [[MouShellInit|MouShellInit]] [[image:Vraag.gif]]
* [[MouGetHotKey|MouGetHotKey]] [[image:Vraag.gif]]
* [[MouSetHotKey]]
* [[MouFree]]


==== Video I/O functions ====
====QuickHelp====
* [[VioRegister|VioRegister]]  
*[[QhKeybdHandle]]
* [[VioGlobalReg|VioGlobalReg]]
*[[QhMouseHandle]]
* [[VioDeRegister|VioDeRegister]]
* [[VioGetPhysBuf|VioGetPhysBuf]]
* [[VioScrollDn|VioScrollDn]]
* [[VioScrollLf|VioScrollLf]]
* [[VioScrollRt|VioScrollRt]]
* [[VioCheckCharType|VioCheckCharType]] [[image:Vraag.gif]]
* [[VioPrtSc|VioPrtSc]]
* [[VioPrtScToggle|VioPrtScToggle]]
* [[VioRedrawSize|VioRedrawSize]] [[image:Vraag.gif]]
* [[VioGetFont|VioGetFont]]
* [[VioSetFont|VioSetFont]]
* [[VioEndPopUp|VioEndPopUp]]
* [[VioGetAnsi|VioGetAnsi]]
* [[VioGetBuf|VioGetBuf]]
* [[VioGetConfig|VioGetConfig]]
* [[VioGetCp|VioGetCp]]   
* [[VioGetCurPos|VioGetCurPos]] 
* [[VioGetCurType|VioGetCurType]]   
* [[VioGetMode|VioGetMode]] 
* [[VioGetState|VioGetState]]   
* [[VioModeUndo|VioModeUndo]]   
* [[VioModeWait|VioModeWait]]   
* [[VioPopUp|VioPopUp]] 
* [[VioReadCellStr|VioReadCellStr]]
* [[VioReadCharStr|VioReadCharStr]]
* [[VioSavRedrawUndo|VioSavRedrawUndo]] 
* [[VioSavRedrawWait|VioSavRedrawWait]] 
* [[VioScrLock|VioScrLock]] 
* [[VioScrollUp|VioScrollUp]]   
* [[VioScrUnLock|VioScrUnLock]] 
* [[VioSetAnsi|VioSetAnsi]]   
* [[VioSetCp|VioSetCp]] 
* [[VioSetCurPos|VioSetCurPos]] 
* [[VioSetCurType|VioSetCurType]]
* [[VioSetMode|VioSetMode]]   
* [[VioSetState|VioSetState]]   
* [[VioShowBuf|VioShowBuf]] 
* [[VioWrtCellStr|VioWrtCellStr]]   
* [[VioWrtCharStr|VioWrtCharStr]]
* [[VioWrtCharStrAtt|VioWrtCharStrAtt]] 
* [[VioWrtNAttr|VioWrtNAttr]]   
* [[VioWrtNCell|VioWrtNCell]]   
* [[VioWrtNChar|VioWrtNChar]] 
* [[VioWrtTTY|VioWrtTTY]]
* [[VioQueryConsole]]


===== Advanced VIO =====
===Keyboard functions===
* [[VioGetOrg]]
*[[KbdCharIn]] - character data record from keyboard
* [[VioSetOrg]]
*[[KbdClose]] - closes logical keyboard
* [[WinDefAVioWindowProc]]
*[[KbdDeRegister]] - deregister keyboard subsystem
</div>
*[[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 (OS/2 1.x)|MouDrawPtr]]
*[[MouFlushQue (OS/2 1.x)|MouFlushQue]]
*[[MouGetDevStatus (OS/2 1.x)|MouGetDevStatus]]
*[[MouGetEventMask (OS/2 1.x)|MouGetEventMask]]
*[[MouGetNumButtons (OS/2 1.x)|MouGetNumButtons]]
*[[MouGetNumMickeys (OS/2 1.x)|MouGetNumMickeys]]
*[[MouGetNumQueEl (OS/2 1.x)|MouGetNumQueEl]]
*[[MouGetPtrPos]]
*[[MouGetPtrShape (OS/2 1.x)|MouGetPtrShape]]
*[[MouGetScaleFact (OS/2 1.x)|MouGetScaleFact]]
*[[MouReadEventQue (OS/2 1.x)|MouReadEventQue]]
*[[MouRemovePtr (OS/2 1.x)|MouRemovePtr]]
*[[MouSetDevStatus (OS/2 1.x)|MouSetDevStatus]]
*[[MouSetEventMask (OS/2 1.x)|MouSetEventMask]]
*[[MouSetPtrPos (OS/2 1.x)|MouSetPtrPos]]
*[[MouSetPtrShape (OS/2 1.x)|MouSetPtrShape]]
*[[MouSetScaleFact (OS/2 1.x)|MouSetScaleFact]]
*[[MouShellInit]]
*[[MouGetHotKey]]
*[[MouSetHotKey]]
*[[MouFree]]


===Legend===
===Video I/O functions===
* [[image:Vraag.gif]]: More information is required on this function. Information was not available on CP1 or PRCP books.
*[[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 (FAPI)|VioShowBuf]]
*[[VioWrtCellStr (FAPI)|VioWrtCellStr]]
*[[VioWrtCharStr (FAPI)|VioWrtCharStr]]
*[[VioWrtCharStrAtt (FAPI)|VioWrtCharStrAtt]]
*[[VioWrtNAttr (FAPI)|VioWrtNAttr]]
*[[VioWrtNCell (FAPI)|VioWrtNCell]]
*[[VioWrtNChar (FAPI)|VioWrtNChar]]
*[[VioWrtTTY (FAPI)|VioWrtTTY]]


==References==
==References==
{|class="wikitable"
* IBM OS/2 Programming Reference
!Title
* IBM OS/2 Warp [[Control Program Programming Guide and Reference]] (1996)
!Author
* IBM API Addendum Volume 1 (PowerPC Edition)
!Year
!Document Ref.
!Links
|-
|[[Control Program Programming Guide and Reference]]
|IBM
|1996
|CP1.INF, CP2.INF, CP3.INF
|[https://archive.org/download/ToolkitDocs1/Control%20Program%20Programming%20Guide%20and%20Reference.pdf PDF], [https://archive.org/download/ToolkitDocs1/Control%20Program%20Programming%20Guide%20and%20Reference%201.inf INF 1] [https://archive.org/download/ToolkitDocs1/Control%20Program%20Programming%20Guide%20and%20Reference%202.inf INF 2] [https://archive.org/download/ToolkitDocs1/Control%20Program%20Programming%20Guide%20and%20Reference%203.inf INF 3]
|-
|API Addendum Volume 1 (PowerPC Edition)
|IBM
|
|APIBAS.INF
|
|-
|Legacy OS/2 Programming Reference
|IBM
|
|PRCP.INF
|
|}


[[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

File Handle Functions

File Query Functions

Directory Search (FileFind) Functions

Directory and Disk Functions

Environment and Search Path Functions

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

Shared Memory Functions

Thread Local Memory Functions

Program Execution Control

Thread Control Functions

Process Control Functions

Session Control Functions

Semaphore Functions

Event Semaphore Functions

Mutex Semaphore Functions

Muxwait Semaphore Functions

Pipe Functions

Named-Pipe Functions

Unnamed-Pipe Functions

  • DosClose - Closes a file or pipe
  • DosCreatePipe - Creates an unnamed (anonymous) pipe
  • DosDupHandle, DosOpen, DosRead, DosWrite

Queue Functions

Timer Functions

Error Management Functions

Exception Handling Functions

Signal Exception Functions

Must-Complete Functions

Device I/O Functions

File System Functions Used to Perform I/O to Devices:

  • DosClose
  • DosOpen
  • DosRead
  • DosWrite

Message Management Functions

Code Page Management Functions

Code Page Functions

Country Dependent Functions

Debugging Functions

  • DosDebug - Used by one process to control another for debugging purposes

Dynamic Linking Functions

Dos...

Unsorted

Date/Time

Timer

Error Management

Exception Management

Large File System

File Manipulation

File Handle Manipulation

File Querying

File System Functions

Resource Management

Threads

VDD

Kbd, Mou, Vio

Keyboard functions

Mouse functions

Video I/O functions

Advanced VIO

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

File Handle Manipulation

File Querying

File System Functions

Memory Management

Huge block
Heap

Message Management

National Language/Code Page

Named Pipes

Resource Management

Semaphores

MuxWait Semaphores

Processes/Threading

Processes

Session Management

Session Manager
Screen Group

Timer

Addressing

Spool

Not found on OS2TK45

I/O Privileges

Segments

QuickHelp

Keyboard functions

Mouse functions

Video I/O functions

References

Retrieved from "https://www.edm2.com/index.php?title=Control_Program_Functions&oldid=80580"