Control Program Functions

From EDM2
(Redirected from OS2 API:CPI)
Jump to: navigation, search

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

  • 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

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

Large File System

Unsorted

Date/Time

Error Management

Exception Management

File Systems/File Management

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

Icon Legend

  • Att.gif: It seems that these functions were not implemented on the OS/2 4.5 Toolkit.
  • Conf.gif: These functions were documented on the Addendum of the OS/2 4.5 Toolkit.
  • Vraag.gif: More information is required on this function.

Legacy Functions

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

Device I/O

Dynamic Linking Library

Monitor functions

Dynamic Link Library

Error Management

OS/2 2.0 and 1.3 only:

Exception Management

File Systems/File Management

Directory Searching

Directory

Disk

Enviroment/Path

File Manipulation

File Handle Manipulation

File Querying

File System Functions

Memory Management

Heap Memory

Message Management

National Language/Code Page

Pipes

Named Pipes

Resource Management

Semaphores

MuxWait Semaphores

Processes/Threading

Processes

Session Management

Screen Group

Quickhelp

Timer

Addressing

Spool

Not found on OS2TK45

To SORT

Keyboard functions

Mouse functions

Video I/O functions

Advanced VIO

Legend

  • Vraag.gif: More information is required on this function. Information was not available on CP1 or PRCP books.

References

Title Author Year Document Ref. Links
Control Program Programming Guide and Reference IBM 1996 CP1.INF, CP2.INF, CP3.INF PDF, INF 1 INF 2 INF 3
API Addendum Volume 1 (PowerPC Edition) IBM APIBAS.INF
Legacy OS/2 Programming Reference IBM PRCP.INF