ITextEditorEvents インターフェイスの OnLocked メソッド

このメソッドはクライアント側で実装されます。Text Editor がロックまたはロック解除された後に呼び出されます。Text Editor は、時間のかかる処理の開始前に自動的にロックされ、その完了後にロック解除されることがあります。また、このコンポーネントは ITextEditor::Locked プロパティによってロックまたはロック解除することもできます。

このメソッドは、コンポーネントがロックされているかロック解除されているかをクライアントに通知します。

​

構文

​

C++

HRESULT OnLocked( VARIANT_BOOL Value );

​

C#

void OnLocked( bool Value );

​

Visual Basic .NET

Sub OnLocked(Value As Boolean)

​

Parameters

Value

[in] コンポーネントがロック状態か、ロック解除状態かを指定します。パラメーターが TRUE の場合、コンポーネントはロックされています。パラメーターが FALSE の場合、コンポーネントはロック解除されています。

​

戻り値

[C++ のみ] このメソッドが S_OK 以外の値を返した場合は、クライアント側でエラーが発生したことを示します。

​

注記

このメソッドのクライアント実装では、メソッド内でスローされるすべての例外を確実にキャッチして処理し、どの例外もメソッドの外部に伝播しないようにする必要があります。例外がメソッドの外部に伝播すると、予期しない結果 (プログラムの終了など) を招くおそれがあります。

​

関連項目

ITextEditorEvents