TElMessagePartHandler.Decode method

TElMessagePartHandler.Decode

TElMessagePartHandler See also

Filter: C# VB.NET Pascal C++ PHP Java

Decodes message or part.

Declaration

[C#]
int Decode(bool bActivatePartHandlers);

[VB.NET]
Function Decode(ByVal bActivatePartHandlers As Boolean) As Integer

[Pascal]
function Decode(bActivatePartHandlers: Boolean): ELMIMERESULT;

[C++]
int32_t Decode(bool bActivatePartHandlers);

[PHP]
integer Decode(bool $bActivatePartHandlers)

[Java]
int decode(boolean bActivatePartHandlers);

Parameters

bActivatePartHandlers - shows if handlers for decoded part (DecodedPart) must be invoked automatically.

Return value

Returns 0 (EL_OK) or 1 (EL_WARNING) on success;
Error otherwise.

Description

    This method decodes message or its part. If decoding succeeds, the next attempts to invoke Decode method will be ignored.
    Decode method invokes OnParse method with State parameter set to pstDecode.
    If message parsing was invoked with bActivatePartHandlers set to false, then enclosed parts (if any) will not be decoded.