イベントコールバック

イベントハンドラは、OnEvent コールバックによって実装されます。どの OnEvent コールバックも同じシグネチャを持ち、Context または Context オブジェクトを引数として取得し、true または false を返します。

C++ の例: OnEvent コールバック

XSIPLUGINCALLBACK CStatus <event_name>_OnEvent( CRef& in_ctxt )
{
	Context ctxt( in_ctxt );

	// 	Your code goes here ...

	// 	Return false to perform the operation, true to abort
	return false;
}

C# の例: OnEvent コールバック

public class <event_name>
{
   public bool OnEvent( Context in_ctxt )
   {
		// 	Your code goes here ...
	
		// 	Return false to perform the operation, true to abort
		return false;
	}
}

JScript の例: OnEvent コールバック

function <event_name>_OnEvent( in_ctxt )
{
	// Your code goes here ...

	// Return false to perform the operation, true to abort
	return false;
}

Python の例: OnEvent コールバック

def <event_name>_OnEvent( in_ctxt ):
	# Your code goes here ...

	# Return 0 (false) to perform the operation, 1 (true) to abort
	return 0

VBScript の例: OnEvent コールバック

Function <event_name>_OnEvent( in_ctxt )
	' Your code goes here ...

	' Return False to perform the operation, True to abort
	<event_name>_OnEvent = False
End Function

中断できる場合

保存、読み込み、書き出しのような操作の場合、OnEvent 戻り値に、操作を中止するかどうかが指定されます。操作を中断する場合は、True を返します。それ以外の場合は、False を返して操作の続行を許可します。

次のイベントを中断することができます。