TIdDecoder.DecodeBegin Method

Prepares the decoder for storing decoded values to a stream.

Pascal

procedure DecodeBegin(
    ADestStream: TIdStream
); virtual;

Parameters

Parameters	Description
ADestStream	Stream containing encoded values.

Description

DecodeBegin is a procedure used to initialize the decoder for reading encoded values and storing the decoded results in the TIdStream instance speficified in ADestStream.

DecodeBegin is normally called prior to calling the Decode method with arguments representing the encoded values to write to the stream in ADestStream. DecodeBegin assigns the TIdStream instance specified in ADestStream to the internal member variable allocated for the decoder.

DecodeEnd is normally called after all required calls to the Decode method to signal that the decoding operation is complete.

DecodeBegin, Decode, and DecodeEnd are all used in the implementation of the DecodeString method.

Example

function TIdDecoder.DecodeString(const aIn: string): string;
var
  LStream: TIdMemoryStream;
begin
  LStream := TIdMemoryStream.Create;
  try
    DecodeBegin(LStream);
    try
      Decode(AIn);
      LStream.Position := 0;Result := ReadStringFromStream(LStream);
    finally
      DecodeEnd;
    end;
  finally
    Sys.FreeAndNil(LStream);
  end;
end;