IInkCustomStrokes::Remove メソッド (msinkaut.h)
IInkCustomStrokes コレクションから InkStrokes コレクションを削除します。
構文
HRESULT Remove(
[in] VARIANT Identifier
);
パラメーター
[in] Identifier
カスタム ストロークのコレクションから削除するストロークのコレクションの名前またはインデックス。
VARIANT 構造体の詳細については、「 COM ライブラリの使用」を参照してください。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
リターン コード | 説明 |
---|---|
|
正常終了しました。 |
|
パラメーターに無効なポインターが含まれていました。 |
|
操作を完了するためにメモリを割り当てることができません。 |
|
メソッド内で例外が発生しました。 |
|
入力パラメーターが無効です。 |
|
InkStrokes コレクションの InkDisp オブジェクトと IInkStrokeDisp オブジェクトが一致しません。 |
|
未指定のエラーが発生しました。 |
|
無効なバリアントが渡されました。 |
解説
IInkCustomStrokes コレクションは、インク データへの参照のセットであり、実際のデータ自体ではありません。 このメソッドは、データのスナップショットまたは参照からストロークのコレクションのみを削除し、実際のインク データを削除しません。 実際のインク データからコレクションを削除するには、InkDisp オブジェクトの DeleteStrokes メソッドを呼び出します。
Identifier パラメーターには、BSTR または LONG のいずれかを指定できます。 コレクションに追加されたカスタム ストロークに最初に指定された名前には BSTR を使用し、コレクション内のカスタム ストロークのインデックスには long を使用します。 スクリプト言語を使用する場合など、遅延バインディングを使用している場合にカスタム ストロークの名前を指定するには、 引数を文字列リテラルとして渡し、変数を使用しない必要があります。
BSTR データ型の詳細については、「 COM ライブラリの使用」を参照してください。
要件
サポートされている最小のクライアント | Windows XP Tablet PC Edition [デスクトップ アプリのみ] |
サポートされている最小のサーバー | サポートなし |
対象プラットフォーム | Windows |
ヘッダー | msinkaut.h |
Library | InkObj.dll |