C++ Syntax

__int32

MKI_PlugInRequest(

const LPCWSTR f_pszRequest,

LPWSTR f_pszBuffer,

const size_t f_unBufferSize );

typedef __int32

(*MKI_PLUGINREQUEST_PROC)(

const LPCWSTR f_pszRequest,

LPWSTR f_pszBuffer,

const size_t f_unBufferSize );

This procedure is called each time a textual request has to be resolved. If the plug-in is able to resolve the request stated in Request, it should do so.

Parameters

f_pszRequest

[const LPCWSTR] Textual request to be resolved. The plug-in should check the request and determine whether it is able to resolve such a request or not. If not, the plug-in should immediately exit returning MKI_NOTIFY_RESULT_UNKNOWN.

f_pszBuffer

[LPWSTR] Address of a buffer into which the plug-in shall store the result of the resolved request in form of a zero-terminated string. The result must be a standard text as described in Text Formatting.

f_unBufferSize

[size_t] Size of the buffer in characters, i.e. maximum string length including the terminating zero.

Return Value

Should return one of the following values:

MKI_NOTIFY_RESULT_UNKNOWN

The plug-in does not know the type of request that f_pszRequest contains.

MKI_NOTIFY_RESULT_IGNORE

The plug-in knows the type of request that f_pszRequest contains, but is currently not able to resolve it.

MKI_NOTIFY_RESULT_DONE

The plug-in knows the type of request that f_pszRequest contains and has stored the resolved request in f_pszBuffer.

Comment

The name of the procedure has to be exactly MKI_PlugInRequest.