RealTimeStylus.AddCustomStylusDataToQueue メソッド

2008-10-28

カスタムデータを RealTimeStylus オブジェクトのキューに追加します。

名前空間 : Microsoft.StylusInput
アセンブリ : Microsoft.Ink (Microsoft.Ink.dll 内)

構文

'宣言
Public Sub AddCustomStylusDataToQueue ( _
    queue As StylusQueues, _
    guid As Guid, _
    data As Object _
)
'使用
Dim instance As RealTimeStylus
Dim queue As StylusQueues
Dim guid As Guid
Dim data As Object

instance.AddCustomStylusDataToQueue(queue, _
    guid, data)

public void AddCustomStylusDataToQueue(
    StylusQueues queue,
    Guid guid,
    Object data
)

public:
void AddCustomStylusDataToQueue(
    StylusQueues queue, 
    Guid guid, 
    Object^ data
)

public void AddCustomStylusDataToQueue(
    StylusQueues queue,
    Guid guid,
    Object data
)

public function AddCustomStylusDataToQueue(
    queue : StylusQueues, 
    guid : Guid, 
    data : Object
)

パラメータ

queue
型 : Microsoft.StylusInput.StylusQueues
カスタムデータを追加するキューと、キュー内の場所を指定する StylusQueues 値のいずれか。

guid
型 : System.Guid
追加されるカスタムデータの種類を識別するグローバル一意識別子 (GUID)。

data
型 : System.Object
キューに追加するカスタムデータ。

解説

このメソッドを使用すると、RealTimeStylus オブジェクトのキューにカスタム情報を追加することにより、RealTimeStylus オブジェクトの機能を拡張できます。このような情報は、CustomStylusData オブジェクトとして追加されます。このメソッドは、選択モードと消去モードの開始および終了のためのカスタムデータを作成することにより、RealTimeStylus オブジェクトで選択と消去を実装する 1 つの方法です。

3 つの場所のいずれかでこのメソッドを使用して、RealTimeStylus オブジェクトのキュー StylusQueues にカスタムスタイラスデータを追加できます。

queue パラメータが Input に設定されている場合、カスタムデータは RealTimeStylus オブジェクトの入力キューに追加され、タブレットペンデータストリームから新しいデータが到着する前に同期プラグインコレクションに送信されます。

queue パラメータが Output に設定されている場合、カスタムデータは、RealTimeStylus オブジェクトの出力キューの、同期プラグインコレクションによって現在処理されているデータの後ろに追加されます。

queue パラメータが OutputImmediate に設定されている場合、カスタムデータは、RealTimeStylus オブジェクトの出力キューの、同期プラグインコレクションによって現在処理されているデータの前に追加されます。

それぞれの場合、後続のプラグインによって同期プラグインコレクションに追加されるデータは、前のプラグインによって追加されたデータの後ろに追加されます。

カスタムスタイラスデータは CustomStylusData オブジェクトとしてキューに追加され、プラグインはこのデータを IStylusSyncPlugin.CustomStylusDataAdded メソッドまたは IStylusAsyncPlugin.CustomStylusDataAdded メソッドを介して受け取ります。

RealTimeStylus オブジェクトのスレッド上にないオブジェクトが AddCustomStylusDataToQueue メソッドを呼び出す場合、RealTimeStylus オブジェクトが処理しているパケットと、キュー上のカスタムデータとの関係は不確定です。

注意 :
IStylusSyncPlugin インターフェイスを実装するオブジェクトによって受け取られたカスタムデータに応答して、入力キューにカスタムデータを追加すると、RealTimeStylus オブジェクトのスレッドで無限ループが作成される場合があります。