ISO/IEC 14365:1996
(Main)Information technology — MHS-based electronic messaging C language interfaces — Binding for Application Program Interface (API)
Information technology — MHS-based electronic messaging C language interfaces — Binding for Application Program Interface (API)
The purpose is to define a C programming language binding for the X.400-based electronic messaging Application Program Interface (API) that is defined in ISO/IEC 14361. Identical to IEEE 1327.1-1993
Technologies de l'information — Interfaces de langage C en messagerie électronique basée sur MHS — Liant pour l'interface de programme d'application (API)
General Information
Standards Content (Sample)
INTERNATIONAL
lSO/IEC
STANDARD
First edition
I 996-06-o 1
Information technology - MHS-based
electronic messaging C language
interfaces - Binding for Application
Program Interface (API)
Technologies de /‘information -
Interfaces de langage C en messagerie
klectronique bas6e sur X.400 -
Liant pour /‘interface de programme
d ‘applka tion
(A PI)
Reference number
ISO/l EC 14365: 1996(E)
---------------------- Page: 1 ----------------------
ISO/IEC 14365:1996(E)
Contents
PAGE
0
0 0 0 l 0 0 0 0
Section 1: General . . . . . . . . . . .
0
0 l a 0 0 0 0 l 0 0 l 0
l 0 0 l
1.1 Scope
0 0 a 0 0 0 0 0 8
1.2 Normative References . . . o l l l l
0 0 l 0 a a 0 0 a
1.3 Conformance l l l l l l l l l l l
l 0 0 0 0 . 0 0 0
1.4 Test Methods l l l l l l l l l l l
0 0 0 a 0 0
Section 2: Terminology and General Requirements
0 0 0 0 l 0 0
2.1 Conventions l l l l l l l l l l
0 l 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0
2.2 Definitions
l 0 0 0 0 0 0 . 0 0 .
l l l l l l l l
2.3 General Terms’
0 0 0 0 0 0 l 0 0 0
2.4 Abbreviations l l l l l l l l l
0 0 0 0 l 0 l 0 9
0 l
Section 3: Message Handling Interfaces l l l
0 0 a a . l a 9
0 l 0
3.1 Introduction l l l l l l l l l l
0 0 l a 9
0 l 0 0 l 0
3.2 Datatypes l l l l l l l l l l l
0 l a 0 l 0 9
0 0 l a
3.2.1 Feature l l l l l l l l l
0 0 0 0 0 9
l 0 0 l l
3.2.2 Interval l l l l l l l l l
10
a 0 0 0 0 l . 0 l 0
3.2.3 Object Count o l l l l l l
0 0 0 0 0 l 0 0 0 a 10
3.2.4 Sequence Number l l l l l
0 0 0 0 0 0 0 0 0 0 0 l 0 0 0 10
3.3 Access Functions
l 0 0 l 0 0 0 0 l a 10
3.3.1 Cancel Submfssibn’ l l l l l
11
0 0 0 l 0 l 0 0 0 a
3.3.2 Close l l l l l l l l l l
l 0 0 0 0 0 0 0 0 0 11
3.3.3 Finish Delivery l l l l l l
0 a 0 0 l 0 0 0 12
0 l
3.3.4 Finish Retrieval l l l l l l
a 0 l 0 0 0 0 12
0 0 0
3.3.5 Open l l l l l l l l l l
4
a 0 a 0 0 13
0 0 0 0 0 0 0 0 a 0 a 0
3.3.6 Size
l 0 0 0 0 13
0 a 0 0 0
3.3.7 Start Delivery l l l l l l l
0 0 l 14
0 l 0 0 0 0 l
3.3.8 Start Retrieval l l l l l l l
0 0 0 14
0 0 0 0 0 0 0
3.3.9 Submit l l l l l l l l l
14
0 0 l 0 0 0 l 0 0 0
3.3.10 Wait l l l l l l l l l
15
0 a 0 0 0 0 0 a a 0
3.4 Transfer Function ’s l l l l l l l l
0 l l 0 0 0 0 l l l 15
3.4.1 Close l l l l l l l l l l
0 16
. 0 0 l 0 0 0 0 l
3.4.2 Finish Transfer In l l l l l
16
0 0 0 0 0 l 0 0 l 0
3.4.3 Open l l l l l l l l l l
0 0 0 0 0 0 0 0 l 0 0 0 a 17
0 0 0
3.4.4 Size
0 0 0 l 0 a 0 a 17
0 0
3.4.5 Start Transfer In l l l l l l
0 0 0 0 l 18
0 0 0 0 0
3.4.6 Transfer Out l l l l l l l
0 0 0 0 0 0 0 18
l l l
3.4.7 Wait l l l l l l o l l l
l 0 0 0 0 0 l 0 0 l 19
3.5 Return Codes l l l l l l l l l l
0 ISO/IEC 1996
All rights reserved. Unless otherwise specified, no part of this publication may be repro-
duced or utilized in any form or by any means, electronic or mechanical, including
photocopying and microfilm, without permission in writing from the publisher.
l Case postale 56 l CH-1211 Geneve 20 l Switzerland
ISO/IEC Copyright Office
Printed in Switzerland
ii
---------------------- Page: 2 ----------------------
ISO/IEC 14365:1996(E)
OISO/IEC
3.6 HeaderFile l l l . + l l l l l l . l l l l l . l l 19
21
Section 4: Interpersonal Messaging Packages l l l o l l . l l l l
25
Section 5: Message Handling Packages l l l . l l l l l e l l .
35
Section 6: Secure Messaging Packages l l l l o l l l . l l l .
37
Annex A (informative) Example cximp.h> Header l l l l l . . l l
41
Annex B (informative) Example Header l l l l l . l l .
51
Annex C (informative) Example cxsmp.h> Header l l l l l l . l l
53
Annex D (informative) Bibliography l l l l . l l l l l . l l l
55
Alphabetic Topical Index l l . . l l l . l o l . l l l l . l
TABLES
6
Table 2-l - Derivation of C Identifiers l l l l l l l . . o . l
22
Table 4-l - Identifiers for IM Package Classes l l l l . . . l l
Table 4-2 - Identifiers for IM Package Acknowledgement Mode
Enumeration l o o o o l l l l l l l l l l l l . l l l 22
- Identifiers for IM Package Discard Reason Enumeration l . 22
Table 4-3
- Identifiers for IM Package IA5 Repertoire Enumeration l l 22
Table 4-4
l 23
Table 4-5 - Identifiers for IM Package Auto-submitted Enumeration l
l . l 23
Table 4-6 - Identifiers for IM Package Importance Enumeration
23
Table 4-7 - Identifiers for IM Package Non-receipt Reason Enumeration
Table 4-8 - Identifiers for IM Package Notification Request Enumeration 23
Table 4-9 - Identifiers for IM Package Sensitivity Enumeration 0 23
- Identifiers for IM Package Videotex Syntax Enumeration l l 23
Table 4-10
- Identifiers for IM Package Attribute Types l . l l l . 24
Table 4-11
24
Table 4-12 - Identifiers for IM Package Value Lengths l l . l l l l
Table 5-l - Identifiers for MM Package Classes . l l l l . l . l 25
26
Table 5-2 - Identifiers for MH Package Action Enumeration l l . l .
Table 5-3 - Identifiers for MH Package Builtin EIT Enumeration l . l 27
- Identifiers for MH Package Delivery Mode Enumeration l . 27
Table 5-4
- Identifiers for MH Package Delivery Point Enumeration l l 27
Table 5-5
l l l 28
Table 5-6 - Identifiers for MH Package Diagnostic Enumeration
28
Table 5-7 - Identifiers for MH Package Explicit Conversion Enumeration
.
Table 5-8 - Identifiers for MH Package Postal Mode Enumeration l l 29
l l
Table 5-9 - Identifiers for MH Package Postal Report Enumeration 29
Table 5-10 - Identifiers for MH Package Priority Enumeration l l l l 29
Table 5-11 - Identifiers for MH Package Reason Enumeration 29
Table 5-12 - Identifiers for MH Package Redirection Reason Enumeration’ 29
Table 5-13 - Identifiers for MH Package Registration Enumeration l l . 30
. . .
111
---------------------- Page: 3 ----------------------
OISO/IEC
ISO/IEX 14365:1996(E)
30
Table 5-14 - Identifiers for MH Package Report Request Enumeration l l
Identifiers for MH Package Security Classification
Table 5-15 -
Enumeration l l l l l l l l l l l l l l l o l l l l l 30
30
Table 5-16 - Identifiers for MH Package Terminal Type Enumeration l l
l l l l 30
Table 5-17 - Identifiers for MH Package Content Type Integer
31
Table 5-18 - Identifiers for MH Package Content Type OIDs l l l l l
31
Table 5-19 - Identifiers for MH Package External EITs OIDs l l l l l
Table 5-20 - Identifiers for MH Package ODAEIT OIDs l l l l l l 31
31
Identifiers for MH Package Rendition Attributes OIDs l l
Table 5-21 -
Table 5-22 - Identifiers for MH Package Attribute Types l l l l l o 32
Identifiers for MH PackageValue Lengths l l l l l l l 34
Table 5-23 -
Identifiers for MH PackageValue Numbers l l l l l l 34
Table 5-24 -
l l l l l l l o l 35
Table 6-l - Identifiers for SM Package Classes
Table 6-2 - Identifiers for SM Package Attribute Types l l l l l o 36
Table 6-3 - Identifiers for SM Package Value Lengths l l l o l l l 36
Table 6-4 - Identifiers for SM Package Value Numbers l l l l l l 36
---------------------- Page: 4 ----------------------
OISO/IEC ISO/IEC 14365:1996(E)
Foreword
IS0 (the International Organization for Standardization) and IEC (the
International Electrotechnical Commission) form the specialized sys-
tem for worldwide standardization. National bodies that are members
of IS0 or IEC participate in the development of International Stan-
dards through technical committees established by the respective or-
ganization to deal with particular fields of technical activity. IS0 and
IEC technical committees collaborate in fields of mutual interest. Other
international organizations, governmental and non-governmental, in
liaison with IS0 and IEC, also take part in the work.
In the field of information technology, IS0 and IEC have established a
joint technical committee, ISO/IEC JTC 1. Draft International Stan-
dards adopted by the joint technical committee are circulated to
national bodies for voting. Publication as an International Standard
requires approval by at least 75 % of the national bodies casting a vote.
International Standard ISO/IEC 14365 was prepared by IEEE (as
IEEE Std 1327.1-1993) and was adopted, under a special “fast-track
procedure ”, by Joint Technical Committee ISO/IEC JTC 1, Information
technology, in parallel with its approval by national bodies of IS0 and
IEC.
Annexes A to D of this International Standard are for information only.
Foreword
---------------------- Page: 5 ----------------------
OISO/IEC
ISO/IEC 14365:1996(E)
Introduction
2 (This introduction is not a normative part of ISO/IEC 14365, Information technology-MHS-based
3 electronic messaging C language interfaces- Binding for Application Program Interface (API), but is
4 included for information only.)
The purpose of this International Standard is to define a C programming language
binding for the X.400-based electronic messaging Application Program Interface
(API) that is defined in ISO/IEC 14361(3).
8 Related Standards
9 The programming language independent specification on which the programming
10 language binding defined in this International Standard is based is contained in
11 ISO/IEC 14361(3}.
12 ISO/IEC 14361 {3}, and the language bindings derived from it, are intended to be
13 used in conjunction with the OS1 abstract data manipulation API, ISO/IEC 14360
14 which provides a general-purpose API for the creation, examination,
121
15 modification, and deletion of OS1 information objects.
ISO/IEC 14367 (5) specifies a set of requirements to be satisfied by test methods for
16
17 measuring conformance to this International Standard. In addition, such test
methods must also satisfy the requirements specified in ISO/IEC 14363 (4) for test
18
19 methods for measuring conformance to the programming language independent
20 specification of the API.
21 Overview
22 The API defined in this International Standard consists of C language bindings for
23 the language independent datatypes and operation defined in ISO/IEC 14361 (3).
24 In addition, this International Standard provides definitions of symbolic constants
25 and their values associated with the OM packages defined by that International
26 Standard.
Vl Introduction
---------------------- Page: 6 ----------------------
OISO/IEC
ISO/IEC 14365:1996(E)
Related Standards Activities
27
28 The following areas are under active consideration at this time, or are expected to
29 become active in the near future concerning extensions to this International Stan-
30 dard. Similar efforts can be anticipated in the future?
(1) Directory services
31
32 (2) FTAMAPI
(3) Verification testing methods
33
34 (4) Network interface facilities
35
(5) System administration.
36 This International Standard is based on IEEE Std 1327.1-1993 {B2}, which was
37 prepared by the P1224 Working Group, sponsored by the Portable Applications
38 Standards Committee of the IEEE Computer Society.
39 1) A Standards Status Report that lists all current IEEE Computer Society standards projects is
40 available from the IEEE Computer Society, 1730 Massachusetts Avenue NW, Washington, DC
41 20036-1903, USA; Telephone: +1202 371-0101; FAX: +1202 728-9614.
vii
Introduction
---------------------- Page: 7 ----------------------
This page intentionally left blank
---------------------- Page: 8 ----------------------
INTERNATIONAL STANDARD OISO/IEC
ISOIIEC 14365:1996(E)
1 Information technology-MHS-based
2 electronic messaging C language
3 interfaces-Binding for Application Program
4 Interface (API)
5 Section 1: General
6 1.1 Scope
This International Standard defines an ISO/IEC 9989 (1) C language binding to
7
8 the language-independent API defined in ISO/IEC 14361 {3)? It is intended to
9 support application portability at the source-code level and to be used by applica-
10 tion developers, system implementors, test method writers, and users.
11 The interface is oriented towards the needs of gateways and applications that
require full access to the features of the protocols.
12
13 NOTE: There are industry-standard and proprietary APIs that can be used by simple applications
14 that only require the main features of the protocols.
15 1.2 Normative References
16 The following standards contain provisions which, through reference in this text,
17 constitute provisions of this International Standard. At the time of publication,
18 the editions indicated were valid. All standards are subject to revision, and parties
19 to agreements based on this International Standard are encouraged to investigate
20 the possibility of applying the most recent editions of the standards indicated
21 1) The numbers in curly brackets correspond to those of the normative references in 1.2.
1.2 Normative References
---------------------- Page: 9 ----------------------
OISO/IEC
ISO/IEC 14365:1996(E)
below. Members of IEC and IS0 maintain registers of currently valid Interna-
22
tional Standards.
ISO/IEC 9989: 19902), Programming languages-C.
23
(11
ISO/IEC 1.4360: 1996, Information technology-Open Systems Interconnec-
24
(21
tion (OSI) abstract data manipulation -Application Program Interface (API)
25
[Language independent].
26
27 ISO/IEC 14361: 1996, Information technology-MHS-based electronic
28 messaging-Application Program Interface (API) [Language independent].
29 ISOIIEC 14363: 1996, Information technology-Test methods for measuring
messaging-Application Program
30 conformance to MHS-based electronic
31 Interface (API) [Language independent]*
ISOIIEC 14367: 1996, Information technology-Test methods for measuring
32
(5)
MHS- based electronic messaging C language
33 conformance to
Binding for Application Program Interface (API).
34 interfaces-
35 1.3 Conformance
36 1.3.1 Implementation Conformance
37 1.3.1.1 Requirements
38 A conforming implementation for this International Standard shall be a conform-
39 ing implementation, as defined in ISO/IEC 14361 (3), for the programming
40 language binding specification that is contained in this International Standard.
41 1.3.1.2 Documentation
42 A conformance document shall be available for an implementation claiming confor-
43 mance to this International Standard. It shall satisfy the requirements that are
44
defined in ISO/IEC 14361 (3) for a conformance document for a programming
45 language binding specification.
46 The phrases “shall document” or “shall be documented” in this International Stan-
47 dard mean that documentation of the feature shall appear in the conformance
48 document, unless the system documentation is explicitly mentioned.
49 The system documentation should also contain the information found in the confor-
50 mance document.
2) ISO/IEC documents can be obtained from the IS0 Central Secretariat, 1 Rue de Varembk, Case
51
Postale 56, CH-1211, Gen&ve 20, SwitzerlandBuisse.
52
1 General
---------------------- Page: 10 ----------------------
OISO/IEC
ISO/IEC 14365:1996(E)
.
1.3.2 Application Conformance
53 All applications claiming conformance to this International Standard shall fall
within one of the following categories.
54
55 1.3.2.1 Strictly Conforming Application
56 A Strictly Conforming Application for this International Standard is a Strictly
57 Conforming Application as defined in ISO/IEC 14361 (3) for the programming
58 language binding specification contained in this International Standard.
59 1.3.2.2 Conforming Application
60 There is only one type of Conforming Application.
61 1.3.2.2.1 ISO/IEC Conforming Application
62 An ISOLIEC Conforming Application for this International Standard is an ISO/IEC
63 Conforming Application as defined in ISO/IEC 14361 (3) for the programming
64 language binding specification contained in this International Standard.
65 1.3.2.3 Conforming Application Using Extensions
A Conforming Application Using Extensions for this International Standard is a
66
Conforming Application Using Extensions as defined in ISO/IEC 14361 (3) for the
67
68 programming language binding specification contained in this International Stan-
69 dard.
70 1.4 Test Methods
71 Any measurement of conformance to this International Standard shall be per-
72 formed using test methods that conform to ISO/IEC 14363 (4) and to
73 IEEE Std 1328.1-1993 (5).
1.4 Test Methods
---------------------- Page: 11 ----------------------
This page intentionally left blank
---------------------- Page: 12 ----------------------
OISO/IEC
ISWIEC 14365:1996(E)
Section 2: Terminology and General Requirements
2 2.1 Conventions
3 2.1.1 General and Typographic Conventions
4 When presented in Synopsis sections or in extended code fragments, C language
5 source code is printed using fixed width font. Where C language names or code
fragments appear in the text of this International Standard, the following conven-
6
7 tions apply:
8 A C language function, datatype, or code fragment appears in italic font. A
9 function name is indicated by following parentheses, for example,
10 ma submit (>.
-
11 A symbolic constant, other than an error name, is surrounded by braces, for
12 example, {OMP 0 MH FE BASIC-ACCESS).
- - - -
13 A symbolic constant for an error name is surrounded by brackets, for exam-
RC BAD MESSAGE].
14 ple, [MH
- - -
15 2.1.2 C Naming Conventions
16 How the identifier for an element of a C interface is derived from the name of the
17 corresponding element of the generic interface depends upon the type of the ele-
18
ment as specified in Table 2-1. The generic name is prefixed with the character
19 string in the second column of the table, alphabetic characters are converted to the
20 case in the third column, and an underscore (-> is substituted for each hyphen (-) or
21 space ( ).
22 The prefix “mhP” is reserved for use by implementors of the service. The prefixes
23 “mhX” and “MHX” are reserved for the proprietary extension of the interface. In
24 all other respects, such extensions are outside the scope of this International Stan-
25 dard.
26 2.1.3 Language-Independent Conventions
27 The language-independent conventions defined in ISO/IEC 14361 (3) shall apply in
28 this International Standard.
2.1 Conventions
---------------------- Page: 13 ----------------------
ISO/IEC 14365:1996(E) OISO/IEC
Table 2-l - Derivation of C Identifiers
29
30
31 Element Type Prefix Case
MH Lower
32 Datatype
IMJMH-, SM
33 Data value
UPPer
IM C-, MH C, SM C
34 Data value (Class) (See note)
UPPer
IM-C-, MH-C-, SM-C-
35
Data value (Class) (See note) UPPer
IM,, MH VL-, SM-VI,
36
Data value (Value Length) UPPer
IM-VN-, MH-VN-, SMVN
37 Data value (Value Number) - - - -
UPPer
none
Lower
38 Data value component
ma-, mt Lower
39 Function
none Lower
40 Function argument
none Lower
41 Function result
I
42 NOTE: The C identifiers denote only the Elements components of data values of the OM String data
43 type.
44 2.2 Definitions
45 2,2.1 Terminology
46 For the purposes of this International Standard, the following definitions apply:
47 2.2.1.1 conformance document: A document provided by an implementor that
48 contains implementation details as described in 1.3.1.2. [ISO/IEC 9945-l {Bl}]
49 2.2.1.2 implementation defined: An indication that the implementation shall
50 define and document the requirements for correct program constructs and correct
data of a value or behavior. [ISO/IEC 9945-l {Bl}]
51
52 2.2.1.3 may: An indication of an optional feature.
53 With respect to implementations, the word may is to be interpreted as an optional
54 feature that is not required in this International Standard, but can be provided.
55 With respect to Strictly Conforming Applications, the word may means that the
56 optional feature shall not be used. [ISO/IEC 9945-l {Bl}]
2.2.1.4 shall: An indication of a requirement on the implementation or on Strictly
57
Conforming Applications, where appropriate. [ISO/IEC 9945-l {Bl)]
58
59 2.2.1.5 should:
60 (1) With respect to implementations, an indication of an implementation
61 recommendation, but not a requirement.
62 (2) With respect to applications, an indication of a recommended program-
63 ming practice for applications and a requirement for Strictly Conforming
64 Applications. [ISO/IEC 9945-l {Bl}]
2 Terminology and General Requirements
---------------------- Page: 14 ----------------------
OISO/IEC ISO/IEC 14365:1996(E)
2.2.1.6 supported: A condition regarding optional functionality.
65 Certain functionality in this International Standard is optional, but the interfaces
66 to that functionality are always required. If the functionality is supported, the
67 interfaces work as specified by this International Standard (except that they do not
return the error condition indicated for the unsupported case). If the functionality
68
is not supported, the interface shall always return the indication specified for this
69
70 situation. [ISO/IEC 9945-1 {Bl}]
71 2.2.1.7 system documentation: All documentation provided with an implemen-
72 tation, except the conformance document.
Electronically distributed documents for an implementation are considered part of
73
74 the system documentation. [ISO/IEC 9945-l {Bl}]
75 2,2.L$ undefined: An indication that this International Standard imposes no
76 portability requirements on an application ’s use of an indeterminate value or its
77 behavior with erroneous program constructs or erroneous data.
78 Implementations (or other standards) may specify the result of using that value or
79 causing that behavior. An application using such behaviors is using extensions, as
80 defined in 1.3.2.3. [ISO/IEC 9945-P {Bl}]
81 2.2.1.9 unspecified: An indication that this International Standard imposes no
82 portability requirements on applications for correct program constructs or correct
83 data regarding a value or behavior.
84 Implementations (or other standards) may specify the result of using that value or
85 causing that behavior. An application requiring a specific behavior, rather than
86 tolerating any behavior when using that functionality, is using extensions, as
87 defined in 1.3.2.3. [ISO/IEC 9945-l {Bl}]
88 2.3 General Terms
89 The terms used in this International Standard are the same as those defined in
90 ISO/IEC 14361{3).
91
2.4 Abbreviations
92 The abbreviations used in this standard are the same as those defined in ISO/IEC
93 14361 (3).
2.4 Abbreviations
---------------------- Page: 15 ----------------------
This page intentionally left blank
---------------------- Page: 16 ----------------------
OISO/IEC
ISOKEC 14365:1996(E)
Section 3: Message Handling Interfaces
1
2 3.1 Introduction
3 This section defines the C language binding to the message handling interfaces in
4 ISO/IEC 14361(3}.
3.2 Datatypes
5
3.2.1 Feature
6
7 3.2.1.1 C Declaration
8 typedef struct {
feature;
9 OM-object-identifier
activated;
10 OM boolean
11 } MH feature;
-
3.2.1.2 Description
12
This single datatype, used for negotiating the features of a session, corresponds to
13
datatypes defined in
both the mh feature list type and mh-activated - list-type
14
15 ISO/IEC 1436i{3}. - -
16 3.2.2 Interval
17 3.2.2.1 C Declaration
18 typedef OM-uint32 MH-interval;
19 3.2.2.2 Description
20 This datatype, used to denote an interval of time in milliseconds, corresponds to
21 the mh feature type datatype defined in ISO/IEC 14361(3).
- -
3.2 Datatypes
---------------------- Page: 17 ----------------------
ISWIEC 14365:1996(E) OISO/IEC
3.2.3 Object Count
22 3,2.3.1 C Declaration
23
tygedef OM-uint32 MH-object-count;
24 3.2.3.2 Description
25 This datatype, an integer that denotes a number of objects, corresponds to the mh -
-
26 object count type datatype defined in ISO/IEC 14361 (3).
- -
27 3.2.4 Sequence Number
28 3.2.4.1 C Declaration
29
tmedef OM-uint32 MH-sequence-number;
30 3.2.4.2 Description
31 This datatype, used to denote the sequence number of an object in a retrieval
32 queue, corresponds to the mh sequence number-type datatype defined in ISO/IEC
- -
33 14361 (3).
34 3.3 Access Functions
35 The C language functions defined in this section correspond directly to the
36 language-independent operations of ISO/IEC 14361 (3). They are therefore not
37 described further in this International Standard, except where there is some
38 feature of the C language binding that is not present in the language-independent
39 specification.
40 3.3.1 Cancel Submission
41 3.3.1.1 C Declaration
42 OM return code
- -
ma-cancel-submission (
43
session,
44 OM_private object
-
45 OM object mts-identifier
-
46 1 ;
47 3.3J.2 Description
48 This function, used to cancel a submitted message with the deferred delivery
option, corresponds to the ma cancel-submission operation defined in ISO/IEC
49
-
50 14361 (3).
10 3 Message Handling Interfaces
---------------------- Page: 18 ----------------------
OISO/IEC
ISODEC 14365:1996(E)
3.3.1.3 Errors
51 [OM POINTER INVALID]
- -
52 3.3.2 Close
53 3.3.2J C Declaration
54 OM return code
- -
55 ma-close (
session
56 OM_private object
-
> ;
58 3,3,2.2 Description
59 This function, used to terminate an MA session between the client and the service,
60 corresponds to the ma close operation defined in ISO/IEC 14361 (3).
-
3.3.2.3 Errors
[OM POINTER INVALID]
- -
63 3.3.3 Finish Delivery
64 3.3.3.1 C Declaration
65 OM-return-code
66 ma-finish-delivery (
session,
67 OM_private object
-
68 OM object delivery confirmations,
- -
69 OM object non-delivery-reports
-
70 1 ;
71 3.3.3.2 Description
72 This function, used to conclude the delivery in progress in a session, corresponds to
73 the ma finish delivery operation defined in ISO/IEC 14361 (3).
- -
74 3.3.3.3 Arguments
75 delivery confirmations
-
76 When the argument delivery-confirmations is omitted, its
77 absence is signaled by the null pointer.
78 non-delivery-reports
When the argument non deLivery reports is omitted, its absence
79 - -
is signaled by the null pointer.
80
11
3.3 Access Functions
---------------------- Page: 19 ----------------------
OISO/IEC
ISO/IEC 14365:1996(E)
3.3.3.4 Errors
[OM POINTER INVALID]
81
- -
82 3.3.4 Finish Retrieval
83 3.3.4.1 C Declaration
84 OM-return-code
85 ma-finish-retrieval (
session,
86 OM_private-object
remove
87 OM boolean
-
88
1 ;
89 3.3.4.2 Description
90 This function, used to conclude the retrieval in progress in a session, corresponds to
the ma finish retrieval operation defined in ISO/IEC 14361 (3).
91
- -
92 3.3.4.3 Errors
93 [OM POINTER INVALID]
- -
94 3.3.5 Open
95 3.3.5.1 C Declaration
96 OM-return-code
97 ma-open (
user-address,
OM_public-object
98
client-name,
99 OM-string
feature-list[],
100 MH-feature
*session,
101 OM_private-object
*workspace
102 OM-workspace
103
1 ;
104 3.3.5.2 Description
105 This function, used to establish an MA session between the client and the service,
106 corresponds to the ma-open operation defined in ISOAEC 14361(3}.
107 3.3.5.3 Arguments
feature list The sequence of MHJkature structures is terminated by an object
108
-
109 identifier with no components (a length of zero and any value of
the data pointer).
110
When the user-address argument is omitted, its absence is sig-
111 use r-address
112 naled by the null pointer.
3 Message Handling Interfaces
12
---------------------- Page: 20 ----------------------
OISO/IEC ISCWIEC 14365:1996(E)
client-name When the client-name argument is omitted, its absence is sig-
naled by a zero-length string.
113
114 3.3.5.4 Errors
115 [OM_POINTER_INVALID]
116 3.3.6 Size
117 3.3.6.1 C Declaration
118 OM return code
- -
ma-size (
119
session,
120 OM_private - object
*number
121 MH-object-count
1 ;
122
123 3.3.6.2 Description
124 This function, used to determine the number of messages and reports in the
delivery or retrieval queue, corresponds to the ma size operation defined in
125 -
ISO/IEC 14361{3).
126
3.3.6.3 Errors
127
128 [OM-POINTER-INVALID]
129 3.3.7 Start Delivery
130 3.3.7.1 C Declaration
131 OM-return-code
132 ma-start-delivery (
session,
133 OM_private - object
*object
134 OM_private-object
135 1 ;
136 3.3.7.2 Description
137 This function, used to begin the delivery of a message or a report to one or more of
delivery operation
138 the users associated with a session, corresponds to the ma - start -
139 defined in ISO/IEC 14361(3}.
140 3.3.7.3 Errors
141 [OM POINTER INVALID]
- -
13
3.3 Access Functions
---------------------- Page: 21 ----------------------
ISO/IEC 14365:1996(E) OISO/IEC
3.3.8 Start Retrieval
3.3.8.1 C Declaration
143 OM-return-code
144 ma-start-retrieval (
145 OM_private-object session,
146 MH-sequence-number minimum-sequence-number,
147 MH-sequence-number *selected-sequence-number,
148 OM_private-object *object
149
1 ;
3.3.8.2 Description
151 This function, used to begin the retrieval of a message or a report, corresponds to
152 the ma start retrieval operation defined in ISO/IEC 14361 (3).
- -
3.3.8.3 Errors
154
155 3.3.9 Submit
156 3.3.9.1 C Declaration
157 OM-return-code
158 ma-submit (
159 OM_private-object session,
160 OM-object communique,
161 OM_private-object *submission results
-
162
1 ;
163 3,3.9,2 Description
164 This function, used to submit a communique, corresponds to the ma submit opera-
-
165 tion defined in ISO/IEC 14361{3}.
166 3.3.9.3 Errors
167 [OM POINTER INVALID]
- -
168 3.3.10 Wait
3.3.10.1 C Declaration
OM-return-code
170
ma-wait (
171
172 OM_private-object session,
173 MH-interval interval,
14 3 Message Handling Interfaces
---------------------- Page: 22 ----------------------
OISO/IEC ISO/IEC 14365:1996(E)
MH-sequence-number minimum-sequence-number,
OM boolean *available
174 -
175
) ;
176 3.3.10.2 Description
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.