Symbian3/SDK/Source/GUID-B71F0B0C-CFEB-583F-841D-07340DD6B9CE.dita
author Dominic Pinkman <dominic.pinkman@nokia.com>
Tue, 20 Jul 2010 12:00:49 +0100
changeset 13 48780e181b38
parent 7 51a74ef9ed63
permissions -rw-r--r--
Week 28 contribution of SDK documentation content. See release notes for details. Fixes bugs Bug 1897 and Bug 1522.

<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
<!-- Initial Contributors:
    Nokia Corporation - initial contribution.
Contributors: 
-->
<!DOCTYPE concept
  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="GUID-B71F0B0C-CFEB-583F-841D-07340DD6B9CE" xml:lang="en"><title>Using
TDes8Overflow</title><shortdesc>Use TDes8Overflow to handle overflow issues when calling the<codeph>TDes8::AppendFormat()</codeph> function.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>
<p>The <codeph>Overflow()</codeph> member function of the overflow handler, <xref href="GUID-6A13E649-D15A-3BD7-B5C2-4DC23211F276.dita"><apiname>TDes8Overflow</apiname></xref>,
can be defined and implemented to handle a potential descriptor overflow resulting
from a call to <xref href="GUID-445B19E5-E2EE-32E2-8D6C-C7D6A9B3C507.dita#GUID-445B19E5-E2EE-32E2-8D6C-C7D6A9B3C507/GUID-E8BE9DD1-2D96-3E8E-943A-CD2ECFD78333"><apiname>TDes8::AppendFormat()</apiname></xref>.</p>
<p>There are many actions that the overflow function can perform but some
possibilities are:</p>
<ul>
<li id="GUID-0543F1D9-4DAA-5433-BF08-55CF7DB7D690"><p>just return - in effect,
this suppresses the panic caused by the overflow.</p> </li>
<li id="GUID-F8D403D7-903E-5FAC-8ADC-F2FD0EE6CA6B"><p>leave.</p> </li>
<li id="GUID-B28E1AF3-F1C0-51F4-97C3-EA8CCD2CDF2D"><p>replace the entire string
with some error indication, e.g. "Overflowed"</p> </li>
</ul>
<p>For more complex recovery actions, it may be easier to set a flag in the
implementation of the <codeph>TDes8Overflow</codeph> class and check it on
return from the call to <codeph>AppendFormat()</codeph>.</p>
</conbody></concept>