UWP デバイスアプリでプリンターのメンテナンスを行う方法

2025-04-03

Windows 8.1 では、UWP デバイスアプリは、印刷ヘッドの配置やノズルのクリーニングなど、プリンターのメンテナンスを実行できます。このトピックでは、C# バージョンの印刷ジョブ管理とプリンターのメンテナンスサンプルを使用して、双方向通信 (Bidi) を使用してこのようなデバイスメンテナンスを実行する方法を示します。 UWP デバイスアプリ全般の詳細については、「UWP デバイスアプリを使用する」を参照してください。

C# バージョンの印刷ジョブ管理およびプリンターメンテナンスサンプルでは、DeviceAppForPrinters2 プロジェクトのDeviceMaintenance.xaml.cs ファイルを使用したプリンターのメンテナンスを示します。 Bidi を操作するために、このサンプルでは PrinterExtensionLibrary プロジェクトのプリンター拡張ライブラリを使用します。プリンター拡張ライブラリは、v4 印刷ドライバーのプリンター拡張インターフェイスにアクセスするための便利な方法を提供します。詳細については、プリンター拡張ライブラリの概要を参照してください。

注

このトピックに示すコード例は、印刷ジョブ管理とプリンターのメンテナンスサンプルの C# バージョンに基づいています。このサンプルは、JavaScript と C++ でも使用できます。 C++ は COM に直接アクセスできるため、C++ バージョンのサンプルにはコードライブラリプロジェクトが含まれていないことに注意してください。サンプルをダウンロードして、最新バージョンのコードを確認します。

プリンターのメンテナンス

Windows 8.1 では、デバイスメンテナンスの実装に使用できる v4 プリンタードライバーに新しいプリンター拡張機能インターフェイスが導入されています。 IPrinterBidiSetRequestCallback、 IPrinterExtensionAsyncOperation 、 および IPrinterQueue2。これらのインターフェイスを使用すると、デバイスとプロトコル固有のコマンドに変換してプリンターに送信できるように、Bidi 要求をポートモニターに非同期的に送信できます。詳細については、「デバイスのメンテナンス (v4 プリンタードライバー)」を参照してください。

ヒント

C# アプリと JavaScript アプリは、COM API を直接操作できません。 C# または JavaScript UWP デバイスアプリを作成する場合は、プリンター拡張機能ライブラリを使用してこれらのインターフェイスにアクセスします (このトピックを参照)。

前提条件

開始する前に、以下の操作を行います。

v4 プリンタードライバーを使用してプリンターがインストールされていることを確認します。詳細については、「 v4 印刷ドライバーの開発」を参照してください。
開発用 PC をセットアップします。ツールのダウンロードと開発者アカウントの作成については、「作業の開始」を参照してください。
アプリをストアに関連付けます。詳細については、「 UWP デバイスアプリの作成」を参照してください。
プリンターをアプリに関連付けるプリンターのデバイスメタデータを作成します。詳細については、「デバイスメタデータの作成」を参照してください。
アプリのメインページの UI をビルドします。すべての UWP デバイスアプリはスタート画面から起動でき、全画面表示で表示されます。スタートエクスペリエンスを使用して、デバイスの特定のブランドと機能に一致する方法で製品またはサービスを強調表示します。使用できる UI コントロールの種類に特別な制限はありません。全画面表示エクスペリエンスの設計を開始するには、 Microsoft Store の設計原則を参照してください。
C# または JavaScript を使用してアプリを作成する場合は、 PrinterExtensionLibrary プロジェクトを UWP デバイスアプリソリューションに追加します。このプロジェクトは、印刷ジョブの管理とプリンターのメンテナンスサンプルで確認できます。

注

C++ は COM に直接アクセスできるため、C++ アプリでは、COM ベースのプリンターデバイスコンテキストを操作するために別のライブラリは必要ありません。

手順 1: Bidi 要求を準備する

デバイスメンテナンスインターフェイスでは、Bidi 要求が文字列形式の XML データである必要があります。アプリで意味のある場所であればどこでも、Bidi 要求を作成できます。たとえば、Bidi 要求を文字列定数として保存したり、ユーザー入力に基づいて動的に作成したりできます。印刷ジョブの管理とプリンターのメンテナンスのサンプルでは、OnNavigatedToメソッドで既定の要求を作成します。 Bidi の詳細については、「双方向通信」を参照してください。

この例は、DeviceMaintenance.xaml.cs ファイルの OnNavigatedTo メソッドの例です。

string defaultBidiQuery =
    "<bidi:Set xmlns:bidi=\"http://schemas.microsoft.com/windows/2005/03/printing/bidi\">\r\n" +
    "    <Query schema='\\Printer.Maintenance:CleanHead'>\r\n" +
    "        <BIDI_BOOL>false</BIDI_BOOL>\r\n" +
    "    </Query>\r\n" +
    "</bidi:Set>";

手順 2: プリンターを検索する

アプリでプリンターにコマンドを送信するには、まずプリンターを見つける必要があります。これを行うには、印刷ジョブの管理とプリンターのメンテナンスのサンプルには、(PrinterEnumeration.cs ファイル内の) PrinterEnumerationという名前のクラスが含まれています。このクラスは、デバイスメタデータを使用してアプリに関連付けられているすべてのプリンターを検索し、各プリンターの名前とデバイス ID を含む PrinterInfo オブジェクトの一覧を返します。

この例は、DeviceMaintenance.xaml.cs ファイルの EnumeratePrinters_Click メソッドの例です。このサンプルでは、 PrinterEnumeration クラスを使用して、関連付けられているプリンターの一覧を取得する方法を示します。

private async void EnumeratePrinters_Click(object sender, RoutedEventArgs e)
{
    try
    {
        rootPage.NotifyUser("Enumerating printers. Please wait", NotifyType.StatusMessage);

        // Retrieve the running app's package family name, and enumerate associated printers.
        string currentPackageFamilyName = Windows.ApplicationModel.Package.Current.Id.FamilyName;

        // Enumerate associated printers.
        PrinterEnumeration pe = new PrinterEnumeration(currentPackageFamilyName);
        List<PrinterInfo> associatedPrinters = await pe.EnumeratePrintersAsync();

        // Update the data binding source on the combo box that displays the list of printers.
        PrinterComboBox.ItemsSource = associatedPrinters;
        if (associatedPrinters.Count > 0)
        {
            PrinterComboBox.SelectedIndex = 0;
            rootPage.NotifyUser(associatedPrinters.Count + " printers enumerated", NotifyType.StatusMessage);
        }
        else
        {
            rootPage.NotifyUser(DisplayStrings.NoPrintersEnumerated, NotifyType.ErrorMessage);
        }
    }
    catch (Exception exception)
    {
        rootPage.NotifyUser("Caught an exception: " + exception.Message, NotifyType.ErrorMessage);
    }
}

ヒント

PrinterEnumerationクラスとPrinterInfo クラスの詳細については、PrinterEnumeration.cs ファイルを参照してください。

手順 3: Bidi 要求を送信する

Bidi 要求を送信するには、デバイスメンテナンスインターフェイスに Bidi 文字列とコールバックが必要です。 SendBidiRequest_Click メソッドでは、最初にPrinterInfo オブジェクトを使用して、contextという名前のプリンター拡張コンテキストオブジェクトを作成します。その後、 PrinterBidiSetRequestCallback オブジェクトが作成され、コールバックの OnBidiResponseReceived イベントを処理するイベントハンドラーが追加されます。最後に、プリンター拡張コンテキストの SendBidiSetRequestAsync メソッドを使用して、Bidi 文字列とコールバックを送信します。

この例は、DeviceMaintenance.xaml.cs ファイルの SendBidiRequest_Click メソッドの例です。

private void SendBidiRequest_Click(object sender, RoutedEventArgs e)
{
    try
    {
        PrinterInfo queue = (PrinterInfo)PrinterComboBox.SelectedItem;

        // Retrieve a COM IPrinterExtensionContext object, using the static WinRT factory.
        // Then instantiate one "PrinterExtensionContext" object that allows operations on the COM object.
        Object comContext = Windows.Devices.Printers.Extensions.PrintExtensionContext.FromDeviceId(queue.DeviceId);
        PrinterExtensionContext context = new PrinterExtensionContext(comContext);

        // Create an instance of the callback object, and perform an asynchronous 'bidi set' operation.
        PrinterBidiSetRequestCallback callback = new PrinterBidiSetRequestCallback();

        // Add an event handler to the callback object's OnBidiResponseReceived event.
        // The event handler will be invoked once the Bidi response is received.
        callback.OnBidiResponseReceived += OnBidiResponseReceived;

        // Send the Bidi "Set" query asynchronously.
        IPrinterExtensionAsyncOperation operationContext
            = context.Queue.SendBidiSetRequestAsync(BidiQueryInput.Text, callback);

        // Note: The 'operationContext' object can be used to cancel the operation if required.
    }
    catch (Exception exception)
    {
        rootPage.NotifyUser("Caught an exception: " + exception.Message, NotifyType.ErrorMessage);
    }
}

手順 4: Bidi の応答を受け取る

Bidi の "set" 操作が完了すると、 PrinterBidiSetRequestCallback型のコールバックオブジェクトが呼び出されます。このコールバックは、HRESULT 応答からのエラー処理を処理し、イベントパラメーターを介して Bidi 応答を送信して、 OnBidiResponseReceived イベントをトリガーします。

この例では、DeviceMaintenance.xaml.cs ファイル内のPrinterBidiSetRequestCallback クラス定義を示します。

internal class PrinterBidiSetRequestCallback : IPrinterBidiSetRequestCallback
{
    /// <summary>
    /// This method is invoked when the asynchronous Bidi "Set" operation is completed.
    /// </summary>
    public void Completed(string response, int statusHResult)
    {
        string result;

        if (statusHResult == (int)HRESULT.S_OK)
        {
            result = "The response is \r\n" + response;
        }
        else
        {
            result = "The HRESULT received is: 0x" + statusHResult.ToString("X") + "\r\n" +
                     "No Bidi response was received";
        }

        // Invoke the event handlers when the Bidi response is received.
        OnBidiResponseReceived(null, result);
    }

    /// <summary>
    /// This event will be invoked when the Bidi 'set' response is received.
    /// </summary>
    public event EventHandler<string> OnBidiResponseReceived;
}

その後、Bidi 応答が OnBidiResponseReceived メソッドに送信されます。ここで、 Dispatcher を使用して UI スレッドに結果が表示されます。

この例は、DeviceMaintenance.xaml.cs ファイルの OnBidiResponseReceived メソッドの例です。

internal async void OnBidiResponseReceived(object sender, string bidiResponse)
{
    await Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
    {
        BidiResponseOutput.Text = bidiResponse;
    });
}

テスティング

UWP デバイスアプリをテストする前に、デバイスメタデータを使用してプリンターにリンクする必要があります。

デバイスアプリ情報をプリンターに追加するには、プリンターのデバイスメタデータパッケージのコピーが必要です。デバイスメタデータがない場合は、「UWP デバイスアプリのデバイスメタデータを作成する」のトピックの説明に従って、デバイス メタデータ作成ウィザードを使用して作成できます。

注

デバイスメタデータ作成ウィザードを使用するには、このトピックの手順を完了する前に、Microsoft Visual Studio Professional、Microsoft Visual Studio Ultimate、または Windows 8.1 用スタンドアロン SDK をインストールする必要があります。 Microsoft Visual Studio Express for Windows をインストールすると、ウィザードを含まないバージョンの SDK がインストールされます。

次の手順では、アプリをビルドし、デバイスメタデータをインストールします。

テスト署名を有効にします。
1. %ProgramFiles(x86)%\Windows Kits\8.1\bin\x86 から、DeviceMetadataWizard.exe をダブルクリックしてデバイスメタデータ作成ウィザードを起動してください。
2. [ツール] メニューの [テスト署名を有効にする] を選択します。
コンピューターを再起動する
ソリューション (.sln) ファイルを開いてソリューションをビルドします。 F7 キーを押すか、サンプルが読み込まれた後、上部のメニューから Build->Build ソリューション に移動します。
プリンターを取り外してアンインストールします。この手順は、次回デバイスが検出されるときに更新されたデバイスメタデータを Windows が読み取るようにする必要があります。
デバイスメタデータを編集して保存します。デバイスアプリをデバイスにリンクするには、デバイスアプリをデバイスに関連付ける必要があります。 手記： デバイスメタデータをまだ作成していない場合は、「 UWP デバイスアプリのデバイスメタデータを作成する」を参照してください。
1. デバイスメタデータ作成ウィザードがまだ開いていない場合は、DeviceMetadataWizard.exeをダブルクリックして、%ProgramFiles(x86)%\Windows Kits\8.1\bin\x86 から起動します。
2. [ デバイスメタデータの編集] をクリックします。これにより、既存のデバイスメタデータパッケージを編集できます。
3. [ 開く ] ダイアログボックスで、UWP デバイスアプリに関連付けられているデバイスメタデータパッケージを見つけます。 ( devicemetadata-ms ファイル拡張子があります)。
4. [ UWP デバイスアプリ情報の指定 ] ページで、[ UWP デバイス アプリ] ボックスに Microsoft Store アプリ情報を入力します。「インポート UWP アプリマニフェストファイル をクリックすると、パッケージ名、発行元名、および UWP アプリ ID が自動的に入力されます。」
5. アプリがプリンター通知に登録している場合は、「通知ハンドラー」ボックスに記入します。イベント ID に印刷イベントハンドラーの名前を入力します。 イベントアセットで、コードが含まれているファイル名を入力してください。
6. 完了したら、[完了] ページが表示されるまで [次へ] をクリックします。
7. [ デバイスメタデータパッケージの確認 ] ページで、すべての設定が正しいことを確認し、[ ローカルコンピューター上のメタデータストアにデバイスメタデータパッケージをコピー する] チェックボックスをオンにします。 [保存] をクリックします。
デバイスが接続されたときに Windows が更新されたデバイスメタデータを読み取るようにプリンターを再接続します。