updateTraymap

指定したファイルで、ローカルPC上のトレイマップファイル「Traymap.ini」を更新します。Service Pack 1以降で利用できます。

構文

sdp.updateTraymap(traymap)

引数

引数 必須 説明
traymap

更新する設定内容が記載された、XML形式のファイルを指定します。

指定する設定ファイルの詳細については「Traymap.iniの更新用ファイルのフォーマット」を参照してください。

Traymap.iniの更新用ファイルのフォーマット

更新用ファイルは以下の形式で作成する必要があります。

  • 更新用ファイルは、XML形式で記述します。
  • 更新用ファイルのファイル名は任意です。
  • 更新用ファイルは、UTF-8(BOMなし)で作成する必要があります。

設定項目と指定値

Traymap.iniの更新用ファイルに記述できる設定項目と指定値は以下のとおりです。

セクション キー 対応する設定内容と指定値
プリンター名

トレイマップを適用するプリンター名を指定します。

複数のプリンターがある場合は、セクション(プリンター名)ごとにAPIで指定したトレイ番号と給紙トレイを紐付けすることができます。

EnumMode

適用するトレイ制御モードを「0」から「2」で指定します。省略時は「0」が指定されたものとして動作します。

  • 0
    API関数のVrSetTray(n)で指定したトレイ番号(n)を、実際のプリンターの以下のトレイと紐付けます。
    • 1
      上段トレイ
    • 2
      中断トレイ
    • 3
      下段トレイ
    • 4
      手差しトレイ
    印刷するプリンターに存在しないトレイを指定した場合など、上記の設定に当てはまらない場合はプリンターの設定に従います。
  • 1
    API関数のVrSetTray(n)で指定したトレイ番号(n)を、プリンタードライバーからトレイ情報を取得する際の取得順に対応させて動作するモードです。
    たとえば、VrSetTray(3)が指定されていて、トレイ情報が[プリンターの設定に従う、自動、トレイ1、トレイ2・・・]となる場合は、「トレイ1」に紐付けられます。
    設定にあてはまらない場合はプリンターの設定に従います。
  • 2

    API関数VrSetTray(n)で指定したトレイ番号(n)に対応する給紙トレイを、各クライアントPCの設定ファイル「Traymap.ini」の記述から取得して動作するモードです。
    SVF Web Direct Printのインストールフォルダーに「Traymap.ini」を配置しておく必要があります。

tray[n]

EnumModeが「2」の場合のみに指定します

VrSetTray(n)で指定したトレイ番号に対応する給紙トレイ(プリンタードライバーのトレイID)を指定します。
当てはまらない場合はプリンターの設定に従います。

Traymap.iniの更新用ファイルの記述例

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<TraymapIni>
  <sections>
    <!-- Printer1 -->
    <section name="Printer1">
      <item
        key="EnumMode"
        value="2"
      />
      <item
        key="Tray1"
        value="1"
      />
      <item
        key="Tray2"
        value="2"
      />
      <item
        key="Tray3"
        value="3"
      />
      <item
        key="Tray4"
        value="4"
      />
    </section>
    <!-- Printer2 -->
    <section name="Printer2">
      <item
        key="EnumMode"
        value="2"
      />
      <item
        key="Tray1"
        value="5"
      />
      <item
        key="Tray2"
        value="6"
      />
      <item
        key="Tray3"
        value="7"
      />
      <item
        key="Tray4"
        value="8"
      />
    </section>
  </sections>
</TraymapIni>

戻り値

Promiseオブジェクトが返却されますので、処理結果による動作の制御に利用できます。
また、JavaScript APIがPromise経由でステータスコードを返すので、ステータスコードを利用した動作の制御も可能です。ステータスコードの使い方については「print」の「指定例」を参照してください。

ステータスコード 内容
-402 Traymap.iniの更新失敗

指定例

Traymap.iniを「http://localhost:8080/traymap.xml」で更新します。
また、更新が成功した場合は警告ダイアログに「update success」を出力し、失敗した場合は「update error」を出力します。

var sdp = new SDP();
var promise = sdp.updateTraymap('http://localhost:8080/traymap.xml');
promise.then(function(){
    window.alert('update success'); //更新成功時の処理
}).catch(function(){
    window.alert('update error'); //更新失敗時の処理
})