Click or drag to resize
CfxFilterEventArgs Class

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

Called to filter a chunk of data. Expected usage is as follows: A. Read input data from |DataIn| and set |DataInRead| to the number of bytes that were read up to a maximum of |DataInSize|. |DataIn| will be NULL if |DataInSize| is zero. B. Write filtered output data to |DataOut| and set |DataOutWritten| to the number of bytes that were written up to a maximum of |DataOutSize|. If no output data was written then all data must be read from |DataIn| (user must set |DataInRead| = |DataInSize|). C. Return RESPONSE_FILTER_DONE if all output data was written or RESPONSE_FILTER_NEED_MORE_DATA if output data is still pending. This function will be called repeatedly until the input buffer has been fully read (user sets |DataInRead| = |DataInSize|) and there is no more input data to filter (the resource response is complete). This function may then be called an additional time with an NULL input buffer if the user filled the output buffer (set |DataOutWritten| = |DataOutSize|) and returned RESPONSE_FILTER_NEED_MORE_DATA to indicate that output data is still pending. Calls to this function will stop when one of the following conditions is met: A. There is no more input data to filter (the resource response is complete) and the user sets |DataOutWritten| = 0 or returns RESPONSE_FILTER_DONE to indicate that all data has been written, or; B. The user returns RESPONSE_FILTER_ERROR to indicate an error. Do not keep a reference to the buffers passed to this function.
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    ChromiumCfxEventArgs
      Chromium.EventCfxFilterEventArgs

Namespace: Chromium.Event
Assembly: ChromiumFX (in ChromiumFX.dll)
Syntax
public class CfxFilterEventArgs : CfxEventArgs

The CfxFilterEventArgs type exposes the following members.

Properties
  NameDescription
Public propertyDataIn
Get the DataIn parameter for the Filter callback.
Public propertyDataInRead
Set the DataInRead out parameter for the Filter callback.
Public propertyDataInSize
Get the DataInSize parameter for the Filter callback.
Public propertyDataOut
Get the DataOut parameter for the Filter callback.
Public propertyDataOutSize
Get the DataOutSize parameter for the Filter callback.
Public propertyDataOutWritten
Set the DataOutWritten out parameter for the Filter callback.
Top
Methods
  NameDescription
Public methodSetReturnValue
Set the return value for the Filter callback. Calling SetReturnValue() more then once per callback or from different event handlers will cause an exception to be thrown.
Public methodToString (Overrides ObjectToString.)
Top
Remarks
See also the original CEF documentation in cef/include/capi/cef_response_filter_capi.h.
See Also