3-4-3 プリンター関連

プリンター情報関連の操作を行うためのAPIについて記載します。

プリンター機種名一覧を取得する

メソッド名 String[] GetPrinterKindNames()
戻り値 プリンター機種名(String)の配列
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
String[] kindNames = UdkConnect.GetPrinterKindNames();
for( int i = 0; i < kindNames.Length; i++ )
{
Console.WriteLine( kindNames[i] );
}

ダウンロード可能なプリンター機種名の一覧を取得する

メソッド名 String[] GetDownloadablePrinterKindNames()
戻り値 ダウンロード可能なプリンター機種名(String)の配列
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
String[] kindNames = UdkConnect.GetDownloadablePrinterKindNames();
for( int i = 0; i < kindNames.Length; i++ )
{
Console.WriteLine( kindNames[i] );
}

プリンター機種のデフォルトプロパティを取得する

メソッド名 nameAndValue [] GetPrinterKindProperties( p1 )
パラメーター
  • p1
    String printerKind(プリンター機種名)
戻り値 プロパティ名と値(nameAndValue)の配列
詳細は「3-5-8 nameAndValueクラスプロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
String kindName = "EMF";
ServiceRef.UdkConnect.nameAndValue [] props = UdkConnect.GetPrinterKindProperties(kindName);
for( int i = 0; i < props.Length; i++ )
{
Console.WriteLine(props[i].name + " = " + props[i].value);
}

サーバープリンター名一覧を取得する

メソッド名 String[] GetServerPrinterNames()
戻り値 サーバープリンター名(String)の配列
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//プリンター名一覧を取得する
String[] kindNames = UdkConnect.GetServerPrinterNames();
for( int i = 0; i < kindNames.Length; i++ )
{
Console.WriteLine(kindNames[i]);
}

サーバープリンター情報を取得する

メソッド名 ServerPrinter GetServerPrinter( p1 )
パラメーター
  • p1
    String printerName(サーバープリンター名)
戻り値 サーバープリンター情報(ServerPrinter)
詳細は「3-5-3 サーバープリンタークラス(serverPrinter)プロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
String printerName = "TestPrinter";
ServiceRef.UdkConnect.ServerPrinter printer = UdkConnect.GetServerPrinter(printerName);
Console.WriteLine(printer.name);

サーバープリンター情報一覧を取得する

メソッド名 ServerPrinter[] GetServerPrinters()
戻り値 サーバープリンター情報(ServerPrinter)の配列
詳細は「3-5-3 サーバープリンタークラス(serverPrinter)プロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//サーバープリンター情報一覧を取得する
ServiceRef.UdkConnect.ServerPrinter[] printers = UdkConnect.GetServerPrinters();
for( int i = 0; i < printers.Length; i++ )
{
  Console.WriteLine(printers[i].name);
}

サーバープリンターのステータスを取得する

メソッド名 ServerPrinter GetServerPrinterStatus( p1 )
パラメーター
  • p1
    String printerName(サーバープリンター名)
戻り値 サーバープリンター情報(ServerPrinter)
詳細は「3-5-3 サーバープリンタークラス(serverPrinter)プロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//プリンターステータスを取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.ServerPrinter serverPrinter = UdkConnect.GetServerPrinterStatus(printerName);
Console.WriteLine(serverPrinter.statusName);
注意
本メソッドを利用する場合、サーバープリンタープロパティのステータス取得プロトコルを「手動」に設定する必要があります。

サーバープリンターのステータスを取得する

メソッド名 ServerPrinter GetServerPrinterStatusWithTimeout( p1, p2 )
パラメーター
  • p1
    String printerName(サーバープリンター名)
  • p2
    int timeoutSec(ソケット通信のタイムアウト(ミリ秒))
    ゼロを指定するとタイムアウトしません。
戻り値 サーバープリンター情報(ServerPrinter)
詳細は「3-5-3 サーバープリンタークラス(serverPrinter)プロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//プリンターステータスを取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.ServerPrinter serverPrinter = UdkConnect.GetServerPrinterStatusWithTimeout(printerName, 100);
Console.WriteLine(serverPrinter.statusName);
注意
本メソッドを利用する場合、サーバープリンタープロパティのステータス取得プロトコルを「手動」に設定する必要があります。

サーバープリンターを停止する

メソッド名 ServerPrinter StopPrinter( p1 )
パラメーター
  • p1
    String printerName(サーバープリンター名)
戻り値 サーバープリンター情報(ServerPrinter)
詳細は「3-5-3 サーバープリンタークラス(serverPrinter)プロパティ」を参照してください。
例外
  • RdConnectException
    プリンター停止に失敗した場合
使用例
//プリンターを停止する
String printerName = "TestPrinter";
UdkConnect.StopPrinter( printerName );

サーバープリンターを再開する

メソッド名 ServerPrinter RestartPrinter( p1 )
パラメーター
  • p1
    String printerName(サーバープリンター名)
戻り値 サーバープリンター情報(ServerPrinter)
詳細は「3-5-3 サーバープリンタークラス(serverPrinter)プロパティ」を参照してください。
例外
  • RdConnectException
    プリンター再開に失敗した場合
使用例
//プリンターを再開する
String printerName = "TestPrinter";
UdkConnect.RestartPrinter( printerName );

サーバープリンターのプロパティを変更する

メソッド名 void UpdateServerPrinterProperties( p1 )
パラメーター
例外
  • RdConnectException
    更新に失敗した場合
使用例
//サーバープリンター情報を取得する
String printerName = "TestPrinter";
ServiceRef.UdkConnect.ServerPrinter printer = UdkConnect.GetServerPrinter(printerName);
for( int i = 0; printer.properties.Length; i++ )
{
  // 印字位置調整量(横)(mm)を調整
  if(printer.properties[i].name.Equals("AdjustX")
  {
    printer.properties[i].value = "10";
  }
  // 印字位置調整量(縦)(mm)を調整
  if(printer.properties[i].name.Equals("AdjustY")
  {
    printer.properties[i].value = "10";
  }
}
//サーバープリンターのプロパティを変更する
UdkConnect.UpdateServerPrinterProperties(printer);

プリンターグループ名一覧を取得する

メソッド名 String[] GetPrinterGroupNames()
戻り値 プリンターグループ名(String)の配列
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//プリンターグループ名一覧を取得する
String[] groupNames = UdkConnect.GetPrinterGroupNames();
for( int i = 0; i < groupNames.Length; i++ )
{
  Console.WriteLine(groupNames[i]);
}

プリンターグループ情報を取得する

メソッド名 PrinterGroup GetPrinterGroup( p1 )
パラメーター
  • p1
    String groupName(プリンターグループ名)
戻り値 プリンターグループ情報(PrinterGroup)
詳細は「3-5-9 プリンターグループクラス(printerGroup)プロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
String groupName = "TestPrinterGroup";
ServiceRef.UdkConnect.PrinterGroup group = UdkConnect.GetPrinterGroup(groupName);
Console.WriteLine(group.name);

プリンターグループ情報一覧を取得する

メソッド名 PrinterGroup[] GetPrinterGroups()
戻り値 プリンターグループ情報(PrinterGroup)の配列
詳細は「3-5-9 プリンターグループクラス(printerGroup)プロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
ServiceRef.UdkConnect.PrinterGroup[] groups = 
       UdkConnect.GetPrinterGroups();
for( int i = 0; i < groups.Length; i++ )
{
  Console.WriteLine(groups[i].name);
}

プリンターグループを更新する

メソッド名 void UpdatePrinterGroup( p1 )
パラメーター
例外
  • RdConnectException
    更新に失敗した場合
使用例
// プリンターグループを取得する
string printerGroupName = "Group1";
ServiceRef.UdkConnect.printerGroup printerGroup = udkConnect.GetPrinterGroup(printerGroupName);

// 割り付け方法を変更する
printerGroup.rule = 1;  //ラウンドロビン割り付け

// プリンターグループを更新する
udkConnect.UpdatePrinterGroup(printerGroup);