DatStat Illume 4.5 SDK Class Reference

IDatStatPreAuthenticate.PreAuthenticate_Hook Method 

This method will be called prior to any participant authentication by the DatStat Illume Collector.

string PreAuthenticate_Hook(
   HookContext ctx
);

Parameters

ctx
A runtime context used for interacting with the running survey.

Return Value

A login ID suitable for survey participant authentication.

Remarks

The string returned by the call PreAuthenticate_Hook will be used as the login ID of the participant for authentication by the DatStat Illume Collector. To force a login failure, simply return a value which does NOT exist in the participant list of the survey. Returning NULL will have no affect on the normal authentication by DatStat Illume Collector.

Use the HookData property of the HookContext to access an optional custom string passed in by the call to the hook within the survey.

The ErrorMessage property of the HookContext can be used to set a custom error message. However the AlertErrorMessage property is ignored.

See Also

IDatStatPreAuthenticate Interface | DatStat.Collector Namespace | HookContext