Mit diesem Makro können Sie Informationen zu den Mail-Aufträgen abfragen.
Entry-Namen oder SVC-Nummer(n)
SVC 20 (dezimal)
UNIT=940, FUNCTION=23, VERSION=1 | 2
Makroauffrufformat und Operandenbeschreibung
YMLGML |
FL=*TU / *TPR ,VERSION=1 / 2 ,XPAND=PARAM / OUTPAR ,ORDER=*SUM / *ALL ,ORDERID=<var: char:16> ,OWNER=*OWN / *ALL / *OTHER ,USERID=<var: char:8> ,OUTPAR=<var: pointer> ,OUTPARL=<integer: 1..32767> / <var: int:4> ,OPTFILE=*NONE / <var: char:54> |
FL=
Funktionsbereich
*TU
SVC-Schnittstelle wird generiert.
*TPR
CALL-Schnittstelle wird generiert.
VERSION=
Wählt die Schnittstellenversion aus.
1
Es wird die alte Schnittstellenversion ausgewählt.
2
Es wird die neue Schnittstellenversion ausgewählt, die den Operanden OPTFILE und einen zusätzlichen Returncode anbietet.
XPAND=
Dieser Parameter steuert die Expansion der Datenstrukturen, die die Parameterliste des Makros und das Layout des Ausgabebereichs beschreiben.
PARAM
Parameterliste erstellen.
OUTPAR
Daten-Layout für den Ausgabebereich erstellen.
ORDER=
Legt fest, welche Informationen über die Mails in der Warteschlange ausgegeben werden.
*SUM
Fragt die Anzahl der Mails in der Benutzer-Warteschlange ab.
*ALL
Fragt die Auftrags-ID aller Mails in der Benutzer-Warteschlange ab.
*SINGLE
Fragt die Parameter der Mail ab, die im Parameter ORDERID festgelegt wurde.
Es empfiehlt sich, den Makro zunächst mit ORDER=*ALL aufzurufen, um in einem ersten Schritt die IDs aller eigenen Mails (Mails des aufrufenden Benutzers) zu erhalten. Anschließend rufen Sie den Makro gesondert für jede Auftrags-ID mit ORDER=*SINGLE auf, um die Daten der Mail-Parameter abzurufen.
Der zweite Aufruf kann mit YMLGONTF fehlschlagen, wenn zwischen den beiden Aufrufen z.B. eine andere Task einen Aufruf YMCML/YMCMLC oder YMLDML/YM-LDMCL abgesetzt hat.
Ist der Ausgabebereich zu klein für die Parameter-Daten der Mail, beendet sich der Aufruf mit YMLGOSML. Wiederholen Sie in diesem Fall den Aufruf mit einem größeren Ausgabebereich.
ORDERID=
Wenn ORDER=*SINGLE angegeben ist, legt dieser Parameter die ID des Mail-Auftrags fest, zu dem Informationen angefordert werden.
IDENTIFIER
Variable, in der die Auftrags-ID gespeichert ist, oder Register, das die Adresse einer Variablen enthält, in der die Auftrags-ID gespeichert ist.
OWNER=
Legt den Benutzer fest, über dessen Mail-Aufträge Informationen abgerufen werden sollen.
*OWN
Nur Mail-Aufträge des aufrufenden Benutzers abfragen.
*ALL
Mail-Aufträge aller Benutzer abfragen. Aufrufer ohne TSOS-Berechtigung erhalten hier das gleiche Ergebnis wie bei *OWN.
*OTHER
Mail-Aufträge des Benutzers abfragen, der durch den Parameter USERID spezifiziert ist (nur für Aufrufer mit TSOS-Berechtigung erlaubt).
USERID
Wenn OWNER=*OTHER angegeben ist, legt dieser Parameter die Benutzerkennung des Eigentümers der Mail-Aufträge fest.
IDENTIFIER
Variable, in der die Benutzerkennung gespeichert ist, oder Register, das die Adresse einer Variablen enthält, in der die Benutzerkennung gespeichert ist.
OUTPAR=
Legt den Ausgabebereich fest. Dieser Parameter ist erforderlich, wenn ORDER=*ALL und ORDER=*SINGLE angegeben ist.
ORDER=*ALL:
Der Ausgabebereich enthält eine Liste der IDs der Mail-Sende-Aufträge. ORDER=*SINGLE:
Der Ausgabebereich enthält den Mail-Parameter-Bereich der im Parameter ORDERID festgelegten Auftrags-ID.
IDENTIFIER
Variable, in der die Adresse des Ausgabebereichs gespeichert ist, oder Register, das die Adresse einer Variablen enthält, in der die Adresse des Ausgabebereichs gespeichert ist.
OUTPARL=
legt Länge des Ausgabebereichs fest.
INTEGER (1,32767)
Länge des Ausgabebereichs.
IDENTIFIER
Variable, in der die Länge des Ausgabebereichs gespeichert ist, oder Register, das die Länge des Ausgabebereichs enthält.
OPTFILE=
Mit diesem Operanden kann eine Benutzer-Optionsdatei angegeben werden. Der Operand ist nur mit VERSION=2 verfügbar. Im Augenblick gibt es keine Benutzer-Option, die das Verhalten von YMLGML beeinflussen würde. Da sich dies aber in Zukunft ändern kann, empfiehlt es sich, schon jetzt beim YMLGML-Aufruf den OPTFILE-Operanden mit dem gleichen Wert wie bei den YMLSML- und YMLCML-Aufrufen zu versorgen.
*NONE
Keine Datei definiert.
IDENTIFIER
Variable, in der der Name der Optionsdatei gespeichert ist, oder Register, das die Adresse des Namens der Optionsdatei enthält.
Returncode
SRC2 | SRC1 | MRC | MRC-Name | Bedeutung |
|
|
|
| Es wurde kein Fehler festgestellt. |
|
|
|
| Parameterfehler. |
|
|
|
| Interner Fehler. |
|
|
|
| Auftrag nicht gefunden. |
|
|
|
| Ausgabebereich zu klein. |
|
|
|
| Auftrag gehört nicht dem Aufrufer. |
|
|
|
| Ressourcen sind erschöpft. |
|
|
|
| Auftrag durch fremde Task ausgeführt. |
|
|
|
| Subsystem ASTI nicht verfügbar. |
|
|
|
| Kein Auftrag zum Versenden von Mails. |
|
|
|
| Unerwarteter ASTI-Fehler. |
|
|
|
| Service MAILCLNT nicht verfügbar. |
SRC1/2=Sub Returncode 1/2 in Sedezimal-Darstellung; MRC=Main Returncode in Sedezimal-Darstellung
Makroaufruf-Parameter und Ausgabebereich
Der Makroaufruf YMLGML verwendet folgende Datenstrukturen:
Datenstruktur für Eingabe- und Ausgabeparameter des Makroaufrufs YMLGML (XPAND=PARAM)
Ausgabe-Datenstruktur für die von YMLGML gelieferten Informationen (XPAND=OUTPAR)
Die Datenstruktur für die Makroaufruf-Parameter von YMLGML ist wie folgt aufgebaut.
VERSION=1:
Distanz | Identifier | Wert | Bedeutung |
| Parameterbereich | ||
000 |
| Function-Header | |
008 |
| Eingabeparameter | |
008 |
| ID des Auftrags, zu dem Informationen abgefragt werden sollen, falls | |
018 |
| Spezifiziert, welche Informationen abgefragt werden sollen. | |
| 1 | Fragt Anzahl der Mails in der Benutzer-Warteschlange ab. | |
| 2 | Fragt Auftrags-ID aller Mails in der Benutzer-Warteschlange ab. | |
| 3 | Fragt Parameter des in YMLGOIDI spezifizierten Auftrags ab. | |
019 |
| Spezifiziert den Benutzer, über dessen Aufträge Informationen abgefragt werden sollen. | |
| 1 | Nur Aufträge des aufrufenden Benutzers werden abgefragt. | |
| 2 | Aufträge aller Benutzer werden abgefragt. | |
| 3 | Aufträge des in YMLGUSID spezifizierten Benutzers werden abgefragt. | |
01A |
| Reservierter Bereich | |
01C |
| Benutzerkennung, deren Aufträge gelöscht werden sollen. | |
024 |
| Adresse des Ausgabebereichs | |
028 |
| Größe des Ausgabebereichs | |
02C |
| Ausgabeparameter | |
02C |
| Anzahl der Mails in der Warteschlange | |
030 |
| Wenn der YMLGML-Aufruf mit dem Returncode YMLGASTI zurückgewiesen wird, enthält dieses Feld den ASTI-Returncode. |
VERSION=2:
Distanz | Identifier | Wert | Bedeutung |
| Parameterbereich | ||
000 |
| Function-Header | |
008 |
| Eingabeparameter | |
008 |
| ID des Auftrags, zu dem Informationen abgefragt werden sollen, falls | |
018 |
| Spezifiziert, welche Informationen abgefragt werden sollen. | |
| 1 | Fragt Anzahl der Mails in der Benutzer-Warteschlange ab. | |
| 2 | Fragt Auftrags-ID aller Mails in der Benutzer-Warteschlange ab. | |
| 3 | Fragt Parameter des in YMLGOIDI spezifizierten Auftrags ab. | |
019 |
| Spezifiziert den Benutzer, über dessen Aufträge Informationen abgefragt werden sollen. | |
| 1 | Nur Aufträge des aufrufenden Benutzers werden abgefragt. | |
| 2 | Aufträge aller Benutzer werden abgefragt. | |
| 3 | Aufträge des in YMLGUSID spezifizierten Benutzers werden abgefragt. | |
01A |
| Reservierter Bereich | |
01C |
| Benutzerkennung, deren Aufträge gelöscht werden sollen. | |
024 |
| Adresse des Ausgabebereichs | |
028 |
| Größe des Ausgabebereichs | |
02C |
| Benutzer-Optionsdate | |
062 |
| Reservierter Bereich | |
064 |
| Ausgabeparameter | |
064 |
| Anzahl der Mails in der Warteschlange | |
068 |
| Wenn der YMLGML-Aufruf mit dem Returncode YMLGASTI zurückgewiesen wird, enthält dieses Feld den ASTI-Returncode. | |
06C |
| Meldungs-ID | |
073 |
| Reservierter Bereich |
Ergänzende Erläuterungen zu den Ausgabeparametern:
YMLGMID
Dieses Feld enthält einen YML-Meldungsschlüssel für eine Meldung, die den aufgetretenen Fehler beschreibt. Das ist normalerweise die gleiche Meldung, die ein vergleichbarer SHOW-MAIL-ORDER-STATUS-Kommandoaufruf liefern würde.
Auflistung der Expansion der Datenstrukturen für Makroaufruf-Parameter und Ausgabebereich
Expansion:
XPAND= PARAM, OUTPAR
YMLGML MF=D,XPAND=PARAM
1 MFTST MF=D,PREFIX=Y,MACID=MLG,ALIGN=F,
1 DMACID=MLG,SUPPORT=(E,D,C,M,L),DNAME=MLGPARL
000000 2 YMLGPARL DSECT ,
1 * Parameter area
1 YMLGHDR FHDR MF=(C,YMLG),EQUATES=NO FHDR
1 * main return codes
00000000 1 YMLGSUCC EQU 0 No error detected
00000001 1 YMLGPARE EQU 1 Parameter error
00000002 1 YMLGINTE EQU 2 Internal error
00000003 1 YMLGONTF EQU 3 Order not found
00000004 1 YMLGOSML EQU 4 Output area too small
00000005 1 YMLGONTO EQU 5 Order not own
00000006 1 YMLGRSRC EQU 6 Resource saturation
00000007 1 YMLGFTSK EQU 7 Order issued by foreign
task
00000008 1 YMLGANAV EQU 8 Subsystem ASTI not
available
00000009 1 YMLGNMSO EQU 9 Not a mail send order
0000000A 1 YMLGASTI EQU 10 Unexpected ASTI error
1 *
1 *
000008 1 YMLGIND DS 0XL36 Input parameters
000008 1 YMLGOIDI DS CL16 Order Id
000018 1 YMLGORDS DS FL1 Order specification
1 * order
00000001 1 YMLGOSUM EQU 1 sum
00000002 1 YMLGOALL EQU 2 all
00000003 1 YMLGOSNG EQU 3 single
1 *
000019 1 YMLGOWNS DS FL1 Owner specification
1 * owner
00000001 1 YMLGWOWN EQU 1 OWN
00000002 1 YMLGWALL EQU 2 ALL
00000003 1 YMLGWOTH EQU 3 OTHER
1 *
00001A 1 YMLGRSV1 DS CL2 Reserved
00001C 1 YMLGUSID DS CL8 User id of owner
000024 1 YMLGOUT DS A Output area
000028 1 YMLGOUTL DS F Output area length
1 *
1 *
00002C 1 YMLGOUTD DS 0XL8 Output parameters
00002C 1 YMLGSUM DS F Number of queued mails
000030 1 YMLGARET DS F Return code from ASTI
1 *
00000034 1 YMLG# EQU *-YMLGHDR
YMLGML MF=D,XPAND=OUTPAR
1 MFTST MF=D,PREFIX=Y,MACID=MLG,ALIGN=F,
1 DMACID=MLG,SUPPORT=(E,D,C,M,L),DNAME=MLGOUTPAR
000000 2 YMLGOUTPAR DSECT ,
1 * rc
00000000 1 YMLGBOK EQU 0 OK
00000001 1 YMLGBPER EQU 1 Parameter error
00000002 1 YMLGBRSC EQU 2 Resource saturation
00000003 1 YMLGBSMT EQU 3 SMTP error
00000004 1 YMLGBSMI EQU 4 SMIME error
0000000A 1 YMLGBINT EQU 10 Internal error
1 *
1 * STRUCT Output parameters
000000 1 YMLGOUTP DS 0XL192 UNION Output parameters
1 *
000000 1 YMLGMDAT DS 0XL192 mail data
000000 1 YMLGSTAT DS F mail status
1 * order status
00000001 1 YMLGWAIT EQU 1 waiting
00000002 1 YMLGDEFE EQU 2 deferred
00000003 1 YMLGACTV EQU 3 active
00000004 1 YMLGSENT EQU 4 send successful
00000005 1 YMLGFAIL EQU 5 send failed
1 *
000004 1 YMLGTIME DS F submission time
000008 1 YMLGUSER DS CL8 submitter
000010 1 YMLGSLCT DS F data selector
1 * Data type selector
00000001 1 YMLGSORD EQU 1 order data
00000002 1 YMLGSDAT EQU 2 result data
1 *
000014 1 YMLGDATA DS 0XL164 UNION data
1 *
000014 1 YMLGRDAT DS 0XL164 result data
000014 1 YMLGRETC DS F return code
000018 1 YMLGRETM DS CL160 return message
1 *
0000B8 00000014 1 ORG YMLGDATA
1 *
000014 1 YMLGODAT DS 0XL4 order data
000014 1 YMLGCNTT DS F # sending tries
1 *
000018 000000B8 1 ORG YMLGDATA+164
0000B8 1 YMLGMPLN DS F mail parameter length
0000BC 1 YMLGMP DS CL4 mail parameters, real
size:
1 * mail_par_len
1 *
0000C0 00000000 1 ORG YMLGOUTP
1 *
000000 1 YMLGOIDS DS 0XL20 order Ids
000000 1 YMLGNORD DS F number of orders
000004 1 YMLGOID DS 1CL16 Array of order ids, real
1 * array size: num_order
00000001 1 YMLGOID# EQU 1
1 *
000014 000000C0 1 ORG YMLGOUTP+192
000000C0 1 YMLGOUTPAR# EQU *-YMLGSTAT