DLM API Functions

The names of all DLM API functions begin with the prefix dlm_ to indicate their source as the DLM API. The body of the function name is designed to state in 2 or 3 words exactly what the function does. For instance, dlm_MonInitialize() is called to initialize the monitor module. The words which compose the function name are usually spelled out completely to avoid cryptic abbreviations and to improve the readability of code and to make it self-documenting.

Each module's include file contains the C language prototypes for that module's functions. The table below shows the include file for each module.

ModuleInclude File
File dlmfile.h
Server dlmsrv.h
Tap dlmtap.h

Prototypes for utility and message functions and most type and macro definitions used by the API are found in dlmdef.h. However, a few module specific type and macro definitions are found in the module include file.

Most API functions return non-negative values to indicate successful completion and negative values to indicate failure. (See DLM API Error Codes for a detailed discussion of individual error codes).