GetPMPrinterClassList関数

帳票サーバに登録されているプリンタクラスの一覧を取得します。

〈このページの構成〉

形式
パラメタ
戻り値
呼び出し例

形式

------------------宣言部------------------
01 EURPMPARAMCLASS.
  02 FILLER        PIC  X(4) VALUE '0770'.
  02 FILLER        PIC  X(1) VALUE LOW-VALUE.
  02 ERRORMESSAGE  PIC  X(256) VALUE SPACE.
  02 FILLER        PIC  X(1) VALUE LOW-VALUE.
  02 FILLER        PIC  X(2) VALUE LOW-VALUE.
  02 CLASSNUM      PIC  9(9) COMP-X VALUE n.
  02 CLASSES       OCCURS n TIMES.
    03 CLASSNAME   PIC  X(80) VALUE SPACE.
    03 FILLER      PIC  X(1) VALUE LOW-VALUE.
    03 PRINTERNAME PIC  X(80) VALUE SPACE.
    03 FILLER      PIC  X(1) VALUE LOW-VALUE.
    03 TRAYNAME    PIC  X(80) VALUE SPACE.
    03 FILLER      PIC  X(1) VALUE LOW-VALUE.
    03 COMMENT     PIC  X(256) VALUE SPACE.
    03 FILLER      PIC  X(1) VALUE LOW-VALUE.
  02 PMSERVERADDR  PIC  X(15) VALUE SPACE.
  02 FILLER        PIC  X(1) VALUE LOW-VALUE.
  02 PMSERVERPORT  PIC  S9(9) COMP-5 VALUE -1.
01 RTNCODE         PIC  S9(9) BINARY.
------------------実行部------------------
call 'GetPMPrinterClassList'   USING BY REFERENCE EURPMPARAMCLASS
                               RETURNING RTNCODE.

ページの先頭へ

パラメタ

CLASSNUM

パラメタCLASSESの繰り返し回数nを指定します。nには取得する一覧の最大数を指定してください。

プリンタクラスの数がn個を超える場合は，n個までの一覧が取得されます。

CLASSES

取得したプリンタクラスの一覧が格納される領域を指定します。詳細は戻り値CLASSESを参照してください。

nには取得する一覧の最大数を指定してください。

PMSERVERADDR

帳票サーバのIPアドレスを255.255.255.255形式で指定します。

PMSERVERADDRパラメタを省略する場合は，空白を指定します。

PMSERVERPORT

帳票サーバのポート番号を指定します。

PMSERVERPORTパラメタを省略する場合は，-1を指定します。

ページの先頭へ

戻り値

RTNCODE

終了コードが設定されます。終了コードについては，「10.4.1　エラー情報一覧」を参照してください。

ERRORMESSAGE

エラーが発生した場合，エラーメッセージとメッセージIDが設定されます。エラーメッセージについては，マニュアル「EUR メッセージ」を参照してください。

エラーが発生しなかった場合は，空白が設定されます。

CLASSNUM

取得されたプリンタクラス数が設定されます。

CLASSES

パラメタCLASSNUMに設定されたn個分のプリンタクラス情報を，戻り値CLASSNAME，PRINTERNAME，TRAYNAME，COMMENTに格納します。取得したプリンタクラスの数がn個に満たない場合は，戻り値CLASSNUMに取得された個数のプリンタクラス情報が返され，戻り値CLASSNUM+1番目以降の領域は不定になります。取得したプリンタクラスの数がn個より多い場合は，パラメタCLASSNUMに指定したn個のプリンタクラス情報が返されます。

CLASSNAME

OS上のプリンタクラス名が設定されます。

PRINTERNAME

OS上のプリンタ名が設定されます。

TRAYNAME

OS上のプリンタクラスのトレイ名が設定されます。

COMMENT

OS上のプリンタクラスの説明が設定されます。

ページの先頭へ

呼び出し例

帳票サーバのプリンタクラスの一覧を取得する，呼び出し例を次に示します。

------------------宣言部------------------
01 EURPMPARAMCLASS.
  02   FILLER       PIC  X(4) VALUE '0770'.
  02   FILLER       PIC  X(1) VALUE LOW-VALUE.
  02   ERRORMESSAGE PIC  X(256) VALUE SPACE.
  02   FILLER       PIC  X(1) VALUE LOW-VALUE.
  02   FILLER       PIC  X(2) VALUE LOW-VALUE.
  02   CLASSNUM     PIC  9(9) COMP-X VALUE 120.
  02   CLASSES      OCCURS 120 TIMES.
    03  CLASSNAME   PIC  X(80) VALUE SPACE.
    03  FILLER      PIC  X(1) VALUE LOW-VALUE.
    03  PRINTERNAME PIC  X(80) VALUE SPACE.
    03  FILLER      PIC  X(1) VALUE LOW-VALUE.
    03  TRAYNAME    PIC  X(80) VALUE SPACE.
    03  FILLER      PIC  X(1) VALUE LOW-VALUE.
    03  COMMENT     PIC  X(256) VALUE SPACE.
    03  FILLER      PIC  X(1) VALUE LOW-VALUE.
  02 PMSERVERADDR   PIC  X(15) VALUE SPACE.
  02 FILLER         PIC  X(1) VALUE LOW-VALUE.
  02 PMSERVERPORT   PIC  S9(9) COMP-5 VALUE -1.
01 RTNCODE          PIC  S9(9) BINARY.
------------------実行部------------------
DISPLAY '＜プリンタクラス一覧(GetPMPrinterClassList)＞'
CALL 'GetPMPrinterClassList' USING BY REFERENCE EURPMPARAMCLASS
                             RETURNING RTNCODE
DISPLAY RTNCODE
IF RTNCODE = ZERO
THEN
  DISPLAY '正常終了'
  DISPLAY CLASSNUM
  PERFORM VARYING IX1 FROM 1 BY 1 UNTIL IX1 > CLASSNUM
    DISPLAY CLASSNAME(IX1)
    DISPLAY PRINTERNAME(IX1)
    DISPLAY TRAYNAME(IX1)
    DISPLAY COMMENT(IX1)
  END-PERFORM
ELSE
  DISPLAY 'エラー発生'
END-IF

ページの先頭へ