PMDF Programmer's Reference Manual

Contents

Preface
Preface	Preface
Chapter 1
1	The PMDF API
1.1	Introduction to the API Routines
1.2	Enqueuing Messages
1.3	Dequeuing Messages
1.4	Multiple Message Enqueue and Dequeue Contexts
1.5	Usage from Multi-threaded Processes
1.6	Message Header Structures
1.7	Programs that Run Indefinitely
1.7.1	OpenVMS Considerations
1.7.2	UNIX & Windows Considerations
1.8	Writing Output from a Channel Program
1.9	Debugging Programs and Logging Messaging Activity
1.10	Required Privileges
1.10.1	OpenVMS Systems
1.10.2	UNIX Systems
1.10.3	Windows Systems
1.11	Compiling and Linking Programs
1.12	Examples of Using the API Routines
1.12.1	Enqueuing a Simple Message
1.12.2	Dequeuing Messages
1.12.3	Dequeuing & Re-enqueuing Messages
1.12.4	Dequeuing & Returning Messages
1.13	API Routine Descriptions
1.13.1	Summary of Routines
1.13.2	Order Dependencies
1.13.3	Strings Passed To and From the API
1.13.4	Routine Descriptions
Command 1	PMDFabortMessage
Command 2	PMDFabortProgram
Command 3	PMDFaddHeaderLine
Command 4	PMDFaddRecipient
Command 5	PMDFaddressDispose
Command 6	PMDFaddressGet
Command 7	PMDFaddressGetProperty
Command 8	PMDFaddressParseList
Command 9	PMDFaliasNoExpansion
Command 10	PMDFcancelCallBack
Command 11	PMDFcloseLogFile
Command 12	PMDFcloseQueueCache
Command 13	PMDFcopyMessage
Command 14	PMDFdatabaseAddEntry
Command 15	PMDFdatabaseClose
Command 16	PMDFdatabaseDeleteEntry
Command 17	PMDFdatabaseGetEntry
Command 18	PMDFdebug
Command 19	PMDFdecodeMessage
Command 20	PMDFdeferMessage
Command 21	PMDFdeleteHeaderLine
Command 22	PMDFdequeueEnd
Command 23	PMDFdequeueInitialize
Command 24	PMDFdequeueMessage
Command 25	PMDFdequeueMessageEnd
Command 26	PMDFdisposeChannelCounters
Command 27	PMDFdisposeHeader
Command 28	PMDFdone
Command 29	PMDFenqueueInitialize
Command 30	PMDFenqueueMessage
Command 31	PMDFgetAddressProperty
Command 32	PMDFgetBlockSize
Command 33	PMDFgetChannelCounters
Command 34	PMDFgetChannelName
Command 35	PMDFgetDateTime
Command 36	PMDFgetEnvelopeId
Command 37	PMDFgetErrorText
Command 38	PMDFgetHostName
Command 39	PMDFgetMessage
Command 40	PMDFgetMessageId
Command 41	PMDFgetPostmasterAddress
Command 42	PMDFgetRecipient
Command 43	PMDFgetRecipientFlags
Command 44	PMDFgetUniqueString
Command 45	PMDFgetUserName
Command 46	PMDFinitialize
Command 47	PMDFlog
Command 48	PMDFmappingApply
Command 49	PMDFmappingLoad
Command 50	PMDFoptionDispose
Command 51	PMDFoptionGetInteger
Command 52	PMDFoptionGetReal
Command 53	PMDFoptionGetString
Command 54	PMDFoptionRead
Command 55	PMDFqueueCacheEnd
Command 56	PMDFqueueCacheGetEntry
Command 57	PMDFreadFailureLog
Command 58	PMDFreadHeader
Command 59	PMDFreadLine
Command 60	PMDFreadText
Command 61	PMDFreceiptControl
Command 62	PMDFrecipientDisposition
Command 63	PMDFreturnMessage
Command 64	PMDFrewindMessage
Command 65	PMDFsetCallBack
Command 66	PMDFsetEnvelopeId
Command 67	PMDFsetLimits
Command 68	PMDFsetMutex
Command 69	PMDFsetRecipientFlags
Command 70	PMDFsetRecipientType
Command 71	PMDFsetReceiptAddresses
Command 72	PMDFstartMessageBody
Command 73	PMDFstartMessageEnvelope
Command 74	PMDFstartMessageHeader
Command 75	PMDFwriteDate
Command 76	PMDFwriteFrom
Command 77	PMDFwriteHeader
Command 78	PMDFwriteLine
Command 79	PMDFwriteSubject
Command 80	PMDFwriteText