Argument.Handler

導入

v4.0

詳細

引数のArgumentHandlerを設定したり、戻したりします。

引数にハンドラがない場合はヌルのリファレンスを戻します。ハンドラプロパティをヌルリファレンスに対して設定すると、引数ハンドラを削除できます。

また、文字列を使用して引数ハンドラを設定することも可能です。この文字列は、引数ハンドラのユニークな名前と一致する文字列である必要があります。使用可能な引数ハンドラのリストについては、siArgumentHandlerを参照してください。

警告：このメソッドを呼び出すと、Argument に関連付けられている既存の値が消失します（「Argument.Value」を参照）。

注：このメソッドCommand.Handlerを、コマンドを実装するスクリプト関数名を戻すと混同しないようにしてください。

C#構文

// get accessor

ArgumentHandler Argument.get_Handler();

// set accessor

Argument.set_Handler( Object out_ppArgumentHandler );

例

JScript の例

// JScript example demonstrating how you can

// find out about ArgumentHandlers associated 

// with the arguments of a Command

// Cleanup

RemoveCommand("CmdWithHandler");

// Command creation

var oCmd = CreateCommand("CmdWithHandler");

oCmd.Code = CmdImpl.toString(); // Embedded command

oCmd.Language = "JScript";

var oCmdArgs = oCmd.Arguments;

var noValue; 

oCmdArgs.AddWithHandler("myArgument", "Collection");

oCmdArgs.Add("myArgWithoutHandler", siArgumentInput, "defaultValue");

AddCommand(oCmd);

// display the arguments

for (i=0; i < oCmdArgs.Count; i++)

{

		var currentArg = oCmdArgs(i);

		var argHandler = currentArg.Handler;

		if (null != argHandler)

		{

			LogMessage(currentArg.Name + " has the following handler: " + argHandler.Name );

		}

		else

		{

			LogMessage(currentArg.Name + " does not have a handler.");

		}

}

// let's remove the argument handler

var oArgWithHandler = oCmdArgs("myArgument");

oArgWithHandler = noValue;

// Implementation of the custom command

function CmdImpl( collectionArg, basicArg )

{

}