[This is preliminary documentation and is subject to change.]

callback function, which the plugin can call to request input from the user. When using one of the standard parameters, the request will be in the selected language.

Namespace: Tools.TotalCommanderT
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
protected string RequestProc(
	InputRequestKind RequestType,
	string CustomTitle,
	string CustomText,
	string DefaultText,
	int maxlen
)
Visual Basic
Protected Function RequestProc ( _
	RequestType As InputRequestKind, _
	CustomTitle As String, _
	CustomText As String, _
	DefaultText As String, _
	maxlen As Integer _
) As String
Visual C++
protected:
String^ RequestProc(
	InputRequestKind RequestType, 
	String^ CustomTitle, 
	String^ CustomText, 
	String^ DefaultText, 
	int maxlen
)
F#
member RequestProc : 
        RequestType:InputRequestKind * 
        CustomTitle:string * 
        CustomText:string * 
        DefaultText:string * 
        maxlen:int -> string
JScript
protected function RequestProc(
	RequestType : InputRequestKind, 
	CustomTitle : String, 
	CustomText : String, 
	DefaultText : String, 
	maxlen : int
) : String

Parameters

RequestType
Type: Tools.TotalCommanderT..::..InputRequestKind
Can be one of the InputRequestKind flags
CustomTitle
Type: System..::..String
Custom title for the dialog box. If NULL or empty, it will be "Total Commander"
CustomText
Type: System..::..String
Override the text defined with RequestType. Set this to NULL or an empty string to use the default text. The default text will be translated to the language set in the calling program.
DefaultText
Type: System..::..String
This string contains the default text presented to the user. Set DefaultText[0]=0 to have no default text.
maxlen
Type: System..::..Int32
Maximum length allowed for returned text.

Return Value

User-entered text if user clicked Yes or OK. Null otherwise

Remarks

Leave CustomText empty if you want to use the (translated) default strings!

Exceptions

ExceptionCondition
System..::..InvalidOperationExceptionInitialized is false
System..::..ArgumentExceptionDefaultText is longer than maxlen
System..::..ArgumentOutOfRangeExceptionmaxlen is less than 1

See Also