Root > Reference > All Types > TELEvCustomWebFieldsRequestProc

Type TELEvCustomWebFieldsRequestProc

Previous pageReturn to chapter overviewNext page   

Procedural event handler for OnCustomWebFieldsRequest event.

 

Unit

EEvents

 

Syntax

 

Code (Delphi)

TELEvCustomWebFieldsRequestProc = procedure(

const ACustom: Pointer;

AExceptionInfo: TEurekaExceptionInfo;

ASender: TObject;

AWebFields: TStrings;

var ACallNextHandler: Boolean

);

 

Parameters

ACustom [in, optional]

Custom user data parameter. It's the same pointer as it was passed to RegisterEvent-function.

 

AExceptionInfo [in, optional]

Information about exception. Can be nil.

 

ASender [in]

Current sender class (child class of TELUniversalSender).

 

AWebFields [in]

Web fields to send to web-site (as name=value pairs).

 

ACallNextHandler [out]

True (default) - call next registered event handler, False - do not call next event handler.

 

Remarks

This event is invoked before sending to allow you to supply custom fields. Fields should be supplied as name=value pairs. We recommend to use the following construct: AWebFields.Values['Field-Name'] := 'Field-Value'. Field name depends on used send method.

 

For example, if you are sending to Mantis - then field name would be custom field name as it appears in Mantis configuration (e.g. like 'cf_count').

 

This event is not called if send method does not need / support custom fields.

 

Note

AExceptionInfo param will be missing if sending is performed outside of exception processing. E.g. if sending is called manually.

 

Warning

Do not confuse custom fields (OnCustomDataRequest event) and web fields (OnCustomWebFieldsRequest event). Custom fields are inserted into bug report file. Web fields are not stored in bug report, web fields are POST-ed to bug tracker / web-site via API or HTTP request.

 

Warning

Event handlers registered via TEurekaLogEvents component will be active only when corresponding form is live (created). Such handlers will not be called before form is created or after it was destroyed. For this reason you may want to register your event handlers via code. For example, it would be a bad idea to use TEurekaLogEvents component for implementing your error dialog, because your dialog will not be displayed for exceptions outside form (e.g. initialization/finalization exceptions, as well as exceptions in form's constructor).

 

See also




Send feedback... Build date: 2024-12-19
Last edited: 2024-12-19
PRIVACY STATEMENT
The documentation team uses the feedback submitted to improve the EurekaLog documentation. We do not use your e-mail address for any other purpose. We will remove your e-mail address from our system after the issue you are reporting has been resolved. While we are working to resolve this issue, we may send you an e-mail message to request more information about your feedback. After the issues have been addressed, we may send you an email message to let you know that your feedback has been addressed.


Permanent link to this article: https://www.eurekalog.com/help/eurekalog/topic_type_eevents_televcustomwebfieldsrequestproc.php