ArcParamToPlug function

Top  Previous  Next

The function gets called by the program to set some parameters.

Syntax C++

unsigned int __stdcall ArcParamToPlug(

                _In_ LONG_PTR Session,

                _In_ HANDLE hArcData,

                _In_ int ParameterType,

                _In_ LONG_PTR ParameterData

);

 

Parameters

Session [in]

Type: LONG_PTR

Session identifier.

hArcData [in]

Type: HANDLE

This parameter contains value, returned by function ArcOpenW.

ParameterType [in]

Type: int

One of the following:

Code

Comments

PK_PARTOPLUG_PASSWORD

0

ParameterData contains a pointer on a unicode 0-terminated string.

PK_PARTOPLUG_LANGUAGE

1

Preferred language for the user.

ParameterData contains a pointer on a unicode 0-terminated string with the current program language.

If empty, the default language (English) is used.

Parameters Session and hArcData are ignored.

The parameter is passed on plugin initialization or language change.

ParameterData [in]

Type: LONG_PTR

Points on parameter value, defined by ParameterType.

Return value

Type: unsigned int

If success returns 0, otherwise – error code.