ホーム › Graphics.Printing › RegisterForPrintAsyncNotifications

RegisterForPrintAsyncNotifications

関数

印刷の非同期通知受信を登録する。

DLLwinspool.drv呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// winspool.drv
#include <windows.h>

HRESULT RegisterForPrintAsyncNotifications(
    LPCWSTR pszName,   // optional
    GUID* pNotificationType,
    PrintAsyncNotifyUserFilter eUserFilter,
    PrintAsyncNotifyConversationStyle eConversationStyle,
    IPrintAsyncNotifyCallback* pCallback,
    HANDLE* phNotify
);

パラメーター

名前	型	方向	説明
pszName	LPCWSTR	inoptional	プリントサーバーまたは印刷キューの名前へのポインター。
pNotificationType	GUID*	in	アプリケーションが受信する必要がある通知の種類に対応するデータスキーマの GUID へのポインター。
eUserFilter	PrintAsyncNotifyUserFilter	in	通知の送信先を指定する値です。 Print Spooler でホストされるプラグイン (送信側) と同じユーザーとして実行されているアプリケーションのみ。より広範な受信側アプリケーション。
eConversationStyle	PrintAsyncNotifyConversationStyle	in	通信が双方向か単方向かを指定する値。
pCallback	IPrintAsyncNotifyCallback*	in	Print Spooler でホストされるコンポーネントがアプリケーションをコールバックするために使用するオブジェクトへのポインター。これが NULL であってはなりません。
phNotify	HANDLE*	out	登録を表す構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

プリンタードライバー、印刷プロセッサー、ポートモニターなど、Print Spooler でホストされる印刷コンポーネントからの通知を、アプリケーションが登録して受信できるようにします。

戻り値

HRESULT	重大度	意味
S_OK	SUCCESS	関数は正常に完了しました。
ALREADY_REGISTERED	ERROR	登録オブジェクトは既に登録されています。
LOCAL_ONLY_REGISTRATION	SUCCESS	ローカル通知の登録には成功しましたが、リモート通知の登録には失敗しました。
MAX_REGISTRATION_COUNT_EXCEEDED	ERROR	登録数が上限に達しました。これ以上の登録は許可されません。
REMOTE_ONLY_REGISTRATION	SUCCESS	リモート通知の登録には成功しましたが、ローカル通知の登録には失敗しました。

戻り値は COM エラーコードです。この関数は操作に成功した場合でも S_OK 以外の HRESULT を返すことがあるため、呼び出しの成否を判定するには SUCCEEDED マクロまたは FAILED マクロを使用してください。関数が返した具体的な HRESULT を取得するには、HRESULT_CODE マクロを使用します。

次のコード例は、これらのマクロを使用して戻り値を評価する方法を示しています。

if (SUCCEEDED(hr)) {
  // 呼び出しは成功。返された HRESULT の値を確認する
  switch (HRESULT_CODE(hr)){
    case S_OK:
      // 何らかの処理 
      break;
      case LOCAL_ONLY_REGISTRATION:
      // 何らかの処理 
      break;
    case REMOTE_ONLY_REGISTRATION:
      // 何らかの処理 
      break;
    default:
      // 既定の処理 
      break;
  }
} else {
  // 呼び出しは失敗。返された HRESULT の値を確認する
  switch (HRESULT_CODE(hr)){
    case ALREADY_REGISTERED:
      // 何らかの処理 
      break;
    case MAX_REGISTRATION_COUNT_EXCEEDED:
      // 何らかの処理 
      break;
    default:
      // 既定の処理 
      break;
  }
}

COM エラーコードの詳細については、エラー処理を参照してください。

その他の返される可能性のある値については、PrintAsyncNotifyError を参照してください。

解説(Remarks)

注意これはブロッキング関数 (同期関数) であり、すぐに制御が戻らない場合があります。この関数が戻るまでの速さは、ネットワークの状態、プリントサーバーの構成、プリンタードライバーの実装など、アプリケーションの作成時には予測が難しい実行時の要因に依存します。ユーザーインターフェイスとのやり取りを管理するスレッドからこの関数を呼び出すと、アプリケーションが応答していないように見えることがあります。

単方向チャネルでの通知を停止するには、受信側アプリケーションが RegisterForPrintAsyncNotifications によって返された pRegistrationHandler の値を UnRegisterForPrintAsyncNotifications に渡します。双方向チャネルの場合は、UnRegisterForPrintAsyncNotifications を呼び出すことで、その呼び出し以降に作成される新しいチャネルでの通知をブロックします。既存の双方向チャネルでの通知をブロックするには、受信側アプリケーションが IPrintAsyncNotifyChannel::CloseChannel でチャネルを閉じる必要があります。

RegisterForPrintAsyncNotifications を呼び出した結果として、pCallback オブジェクトに対して IUnknown::AddRef メソッドが呼び出されます。UnRegisterForPrintAsyncNotifications を呼び出すと、pCallback オブジェクトが解放されます。pCallback オブジェクトの参照カウントは、チャネルが作成されたときにも増加し、チャネルが閉じられたときに減少します。

pSchema パラメーターは、スプーラーが受け取り、リスナークライアントのフィルタリングに使用する GUID ポインターです。スプーラーの非同期通知メカニズムのクライアントは、独自の通知の種類を定義できます。スプーラーは送信される通知の種類を認識しませんが、それでも通知の種類に基づいてリスナークライアントをフィルタリングします。pSchema が参照する通知スキーマは、IPrintAsyncNotifyDataObject を公開する通知オブジェクトが使用するスキーマです。スプーラー通知パイプのクライアントは独自のデータスキーマを定義し、任意のデータ型を相互に送受信できます。pSchema が参照する GUID は、そのデータスキーマに固有のものです。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// winspool.drv
#include <windows.h>

HRESULT RegisterForPrintAsyncNotifications(
    LPCWSTR pszName,   // optional
    GUID* pNotificationType,
    PrintAsyncNotifyUserFilter eUserFilter,
    PrintAsyncNotifyConversationStyle eConversationStyle,
    IPrintAsyncNotifyCallback* pCallback,
    HANDLE* phNotify
);

[DllImport("winspool.drv", ExactSpelling = true)]
static extern int RegisterForPrintAsyncNotifications(
    [MarshalAs(UnmanagedType.LPWStr)] string pszName,   // LPCWSTR optional
    ref Guid pNotificationType,   // GUID*
    int eUserFilter,   // PrintAsyncNotifyUserFilter
    int eConversationStyle,   // PrintAsyncNotifyConversationStyle
    IntPtr pCallback,   // IPrintAsyncNotifyCallback*
    IntPtr phNotify   // HANDLE* out
);

<DllImport("winspool.drv", ExactSpelling:=True)>
Public Shared Function RegisterForPrintAsyncNotifications(
    <MarshalAs(UnmanagedType.LPWStr)> pszName As String,   ' LPCWSTR optional
    ByRef pNotificationType As Guid,   ' GUID*
    eUserFilter As Integer,   ' PrintAsyncNotifyUserFilter
    eConversationStyle As Integer,   ' PrintAsyncNotifyConversationStyle
    pCallback As IntPtr,   ' IPrintAsyncNotifyCallback*
    phNotify As IntPtr   ' HANDLE* out
) As Integer
End Function

' pszName : LPCWSTR optional
' pNotificationType : GUID*
' eUserFilter : PrintAsyncNotifyUserFilter
' eConversationStyle : PrintAsyncNotifyConversationStyle
' pCallback : IPrintAsyncNotifyCallback*
' phNotify : HANDLE* out
Declare PtrSafe Function RegisterForPrintAsyncNotifications Lib "winspool.drv" ( _
    ByVal pszName As LongPtr, _
    ByVal pNotificationType As LongPtr, _
    ByVal eUserFilter As Long, _
    ByVal eConversationStyle As Long, _
    ByVal pCallback As LongPtr, _
    ByVal phNotify As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegisterForPrintAsyncNotifications = ctypes.windll.LoadLibrary("winspool.drv").RegisterForPrintAsyncNotifications
RegisterForPrintAsyncNotifications.restype = ctypes.c_int
RegisterForPrintAsyncNotifications.argtypes = [
    wintypes.LPCWSTR,  # pszName : LPCWSTR optional
    ctypes.c_void_p,  # pNotificationType : GUID*
    ctypes.c_int,  # eUserFilter : PrintAsyncNotifyUserFilter
    ctypes.c_int,  # eConversationStyle : PrintAsyncNotifyConversationStyle
    ctypes.c_void_p,  # pCallback : IPrintAsyncNotifyCallback*
    ctypes.c_void_p,  # phNotify : HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
RegisterForPrintAsyncNotifications = Fiddle::Function.new(
  lib['RegisterForPrintAsyncNotifications'],
  [
    Fiddle::TYPE_VOIDP,  # pszName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pNotificationType : GUID*
    Fiddle::TYPE_INT,  # eUserFilter : PrintAsyncNotifyUserFilter
    Fiddle::TYPE_INT,  # eConversationStyle : PrintAsyncNotifyConversationStyle
    Fiddle::TYPE_VOIDP,  # pCallback : IPrintAsyncNotifyCallback*
    Fiddle::TYPE_VOIDP,  # phNotify : HANDLE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winspool.drv")]
extern "system" {
    fn RegisterForPrintAsyncNotifications(
        pszName: *const u16,  // LPCWSTR optional
        pNotificationType: *mut GUID,  // GUID*
        eUserFilter: i32,  // PrintAsyncNotifyUserFilter
        eConversationStyle: i32,  // PrintAsyncNotifyConversationStyle
        pCallback: *mut core::ffi::c_void,  // IPrintAsyncNotifyCallback*
        phNotify: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winspool.drv")]
public static extern int RegisterForPrintAsyncNotifications([MarshalAs(UnmanagedType.LPWStr)] string pszName, ref Guid pNotificationType, int eUserFilter, int eConversationStyle, IntPtr pCallback, IntPtr phNotify);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_RegisterForPrintAsyncNotifications' -Namespace Win32 -PassThru
# $api::RegisterForPrintAsyncNotifications(pszName, pNotificationType, eUserFilter, eConversationStyle, pCallback, phNotify)

#uselib "winspool.drv"
#func global RegisterForPrintAsyncNotifications "RegisterForPrintAsyncNotifications" sptr, sptr, sptr, sptr, sptr, sptr
; RegisterForPrintAsyncNotifications pszName, varptr(pNotificationType), eUserFilter, eConversationStyle, pCallback, phNotify   ; 戻り値は stat
; pszName : LPCWSTR optional -> "sptr"
; pNotificationType : GUID* -> "sptr"
; eUserFilter : PrintAsyncNotifyUserFilter -> "sptr"
; eConversationStyle : PrintAsyncNotifyConversationStyle -> "sptr"
; pCallback : IPrintAsyncNotifyCallback* -> "sptr"
; phNotify : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winspool.drv"
#cfunc global RegisterForPrintAsyncNotifications "RegisterForPrintAsyncNotifications" wstr, var, int, int, sptr, sptr
; res = RegisterForPrintAsyncNotifications(pszName, pNotificationType, eUserFilter, eConversationStyle, pCallback, phNotify)
; pszName : LPCWSTR optional -> "wstr"
; pNotificationType : GUID* -> "var"
; eUserFilter : PrintAsyncNotifyUserFilter -> "int"
; eConversationStyle : PrintAsyncNotifyConversationStyle -> "int"
; pCallback : IPrintAsyncNotifyCallback* -> "sptr"
; phNotify : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winspool.drv"
#cfunc global RegisterForPrintAsyncNotifications "RegisterForPrintAsyncNotifications" wstr, sptr, int, int, sptr, sptr
; res = RegisterForPrintAsyncNotifications(pszName, varptr(pNotificationType), eUserFilter, eConversationStyle, pCallback, phNotify)
; pszName : LPCWSTR optional -> "wstr"
; pNotificationType : GUID* -> "sptr"
; eUserFilter : PrintAsyncNotifyUserFilter -> "int"
; eConversationStyle : PrintAsyncNotifyConversationStyle -> "int"
; pCallback : IPrintAsyncNotifyCallback* -> "sptr"
; phNotify : HANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。