Collapse all Symbian^3 Product Developer Library

Full Example Code List

This document lists the example code available for each module and collection in the platform.

The following tables are grouped by module and collection. In each table, the left hand column gives a link to the overview for the example. The overviews describe the example's purpose, the APIs it demonstrates, how to build and run it, and they provide a link to download the example's source code.

In most cases, the name in the left hand column is the example's mmp filename. If the example has more than one mmp file, the name of its directory is used. The right hand column gives a summary of the main purpose of the example.

Symbian Platform Fundamentals

Name	Description
HelloWorld	Most basic console application.
CClasses	Shows a basic 'C' class and use of the cleanup stack.
TAndRClasses	Shows a typical 'T' and 'R' class.
MClasses1-3	Shows the use of 'M' (abstract interface) classes.
StaticDLL	Shows how a statically linked DLL is used.

Application Framework

Name	Description
Minimal	Shows a minimal UI application without resource files.
MenuApp	Builds on the Minimal UI application by adding a menu bar defined in a resource file and a menu pane.
EmbApp	Shows embedding a DLL into a stub executable.
server_app_minimal	Shows a minimal server application.
HelloWorld	Shows how to create a simple GUI application with a single view.

Cellular Baseband Services

Telephony Utilities

Name	Description
ETel3rdPartyExample	A set of seven example applications that demonstrate the use of the Telephony ISV API.

Communications Framework

Serial Server

Name	Description
GlassTerm	A terminal application with configurable handshaking that illustrates the use of the Serial Communications API
IRPrinting	Shows the Serial Communications API

Data Server

Name	Description
Rconnection	Shows how to use the RConnection API for connection monitoring and management.

Device Services

System State Management

Name	Description
ssmanager	Shows how to use the System State Manager.

Generic Application Support

Common App Services

Name	Description
AlarmServerExample	Shows the client API to the alarm server.

Time Zone Services

Name	Description
timezoneconversion	Converts times between different time zones and between UTC and local time.
timezonelocalization	Displays and modifies localized time zone information, for instance time zone names.

Generic OS Services

Compression Libraries

Name	Description
EzlibExample	Shows how to use the EZLIB API to do file extraction and compression.

Generic Open Libraries

Name	Description
FileAccessExample	Shows accessing the file system using P.I.P.S.
HelloWorldExample	Creates a simple P.I.P.S. DLL and EXE to demonstrate function lookup by name rather than by ordinal.
hybridapp	Shows a P.I.P.S. 'hybrid' application that uses both C and native Symbian C++ APIs.
IPC	Shows inter-process communication in P.I.P.S.
LibpThreadExample	Shows simple multi-threading and synchronisation in P.I.P.S. using libpthread.dll.
libmexample	Shows the P.I.P.S. Standard C maths library, libm.dll.
ConsoleApp	Shows a simple console-based STDLIB (C Standard library) program that converts quantities from one unit of measurement into another.
GUIApp	Shows a Techview GUI application whose engine is written using STDLIB.
Hello	The simplest possible STDLIB example.
posixsignals	Shows various signal use cases as supported in P.I.P.S.

Open C

Name	Description
openclibz	Shows file compression/decompression. Huffman , filtered data compression, run length encoding, compress a string given by user
handleglobalvar	How to handle global variables within the library code. How to solve WSD (Writable Static Data) problem
opencmessagequeuelibraryex	Send/receive messages using message queue, demonstrated using open C message queue library
opencproducerconsumerex	Demonstrates solution for Producer/ Consumer Problem using Open C.
OpenCStringUtilitiesEx	Demonstrates string utility using open C libraries
redirectprintf	how to redirect stdio to a file. libc library provides freopen API to redirect all standard IOs (namely, stderr, stdin, or stdout).

Generic Services

Name	Description

TaskSchedulerExample	Shows how to schedule and run tasks using the Task Scheduler API.

Low level Libraries and Frameworks

Name	Description
Basics	Shows how to store and restore objects using the clipboard API.
InterfaceClient	One of a set of three related ECom examples that provide an interface definition, a DLL that contains two implementations of that interface, and a client program that uses the interface.
InterfaceDefinition	See InterfaceClient, above.
InterfaceImplementation	See InterfaceClient, above.
ReadText	Most basic resource file example, shows how to read a string resource and print it to the console.
ReadArray	Shows how to load data from a resource file into an array.
MultiRead1	Shows how to open a single resource file and read a resource from it into a descriptor.
MultiRead2	Shows how to open and read from multiple resource files.
ReadData	Shows how to use a resource reader to read data of various types from a resource file into the data members of a class.
SigCheck	Shows how the signature of a resource file is checked before use.

XML

Name	Description
XmlExample	Shows how to use the Xml framework to parse XML and WBXML files.

Graphics

Font and Bitmap Server

Name	Description
BitmapsShell	Shows how to draw and manipulate bitmaps.
CoverflowApp	Illustrates how the graphics architecture called ScreenPlay creates OpenVG content on a semi-transparent or transparent UI.

Graphics Device Interface

Name	Description
EmbeddingShell	Shows drawing, storing and restoring a picture (a CPicture -derived object).
FontsShell	Shows how to draw text using a variety of different fonts.
PDRExample	A console application that reads and displays information about a printer driver and carries out a print job.

Windowing Framework

For background information on these examples, see About the Window Server example code.

Name	Description
Simple	Shows two simple CWindow -derived classes, one of which is the parent of the other.
BitmapSprite	Shows how to create and use an animated sprite (RWsSprite) by reading bitmaps from files.
Direct	Shows the window server's direct screen access (`CDirectScreenAccess`) interface.
Ordinal	Shows the ordinal positioning of windows.
PtBuffer	Shows simple freehand drawing using RWindowBase's pointer move buffer.
Scroll	Shows scrolling using pointer repeat events.
VectorSprite	Shows how to create and use an animated sprite (RWsSprite) by drawing to an off-screen bitmap.
transparent	Shows how to create transparent windows and to change a window's transparency.

General

Name	Description
GraphicsShell	A TechView application that demonstrates drawing points, lines and shapes, and zooming a bitmap and text.

High Level Internet Protocols

Application Layer Protocols

Name	Description
httpexampleclient	A console application that provides a menu-driven interface to demonstrate the HTTP API.

IMS and Streaming

Name	Description
RTPExample	Shows RTP packet streaming.

Kernel and Hardware Services

File Server

Name	Description
Attributes	Shows how to create files and retrieve their entry details and attributes.
BasicSession	Most basic file server example: shows how to connect to and disconnect from the file server.
Connecting	Shows session and system paths.
DriveInfo	Shows how to get a drive list and information about the available drives.
Filenames	Shows how to parse, interrogate and extract components from filenames.
Notify	Shows how to carry out a file management operation and to get notification of its progress using an observer.

User Library

Name	Description
AdvancedClientServerExample	Shows the use of asynchronous and synchronous client/server APIs using a logical device driver (LDD) and a physical device driver (PDD).
SingleRequest	Shows the basic principles of asynchronous programming by issuing and waiting for completion of a single request.
WaitLoop	Shows how a wait loop can be used to identify and handle a completed request.
RealLifeWaitLoop	Shows how the wait loop can deal with multiple asynchronous service providers.
RunComplete	Shows how active objects and an active scheduler can be used to handle asynchronous events, using a timer.
AcceptInput1-2	Shows how active objects and an active scheduler can be used to handle asynchronous events, using keyboard input.
AcceptPrintInput	Shows how active objects and an active scheduler can be used to handle accept and print keyboard inputs to a console.
Fibonacci1-3	Shows how active objects and an active scheduler can be used to handle asynchronous events and long-running services to maintain system responsiveness.
circularbuffer	Shows how to construct and use circular buffers holding different types of objects.
Simple	Shows a simple client that has a single session with a server.
Complex	More complex client/server example, where the server supports multiple subsessions within a session.
Transient:Getting started	Shows how to implement and use Transient servers.
condvarglobal	Shows the use of the global condition variable IPC mechanism.
condvarlocal	Shows the use of the local condition variable IPC mechanism.
Basics	Shows date and time handling.
BinaryData	Shows how descriptors can handle general binary data by explicitly using the 8 bit descriptor class variants.
Buffer	Shows the basic idea of buffer descriptors and how they are used.
InFunct	Shows how to use descriptors as function arguments.
HeapBuffer	Shows how to create and use the heap buffer descriptor HBufC.
Modifier	Shows how to use the modifiable descriptor class TDes.
NonModifier	Shows how to use the non-modifiable descriptor class TDesC.
Pointer	Shows how to use pointer descriptors.
WriteToFile	Basic example that shows how to write text to a file.
DynamicArrays	Shows how to construct and use dynamic arrays.
DynamicBuffers	Shows how to use the flat and segmented buffer classes.
DLLs	Implements two polymorphic DLLs and shows how to load and use them.
RangeChecking	Shows how to use the range checking wrapper class for C++ arrays (TFixedArray).
hashtableexample	Shows how to use the hash table APIs.
Lexer	Shows how to use the lexical analyser, TLex.
linkedlist	Shows how to use singly and doubly linked lists and the delta queue class.
Currency	Shows locale-specific representation of currency values and symbols.
localeupdate	Shows how to load a locale DLL and read settings from it.
ErrorOnFail	Shows use of the `TRAPD` macro, the cleanup stack and the process of leaving. Returns an error code on failure.
LeaveOnFail	As the `ErrorOnFail` example except it leaves on failure.
ELeaveOnFail	As the `LeaveOnFail` example except it calls `new (ELeave)` rather than `new`.
TrapD	Shows the use of the `TRAPD` macro.
PushLAndPop	Shows the use of the cleanup stack and its functions `PushL()` and `Pop()`.
PushLPopDest	Shows the use of the cleanup stack and its functions `PushL()` and `PopAndDestroy()`.
NewL	Shows use of the `NewL()` static function.
NewLC	Shows use of the `NewLC()` static function.
SimpleOOM	Shows cleanup handling for compound classes.
MemLeakOOM	Shows cleanup handling for compound classes, and avoiding memory leaks.
TwoPhaseOOM	Shows the two phase construction technique.
TAnyRObjects1	Shows how cleanup can be implemented for `TAny*` type objects and 'R' type (resource type) objects.
TAnyRObjects2	As `TAnyRObjects1` except it calls `OpenLC()` to open the file and push it onto the cleanup stack in one function call.
Utilities	Shows how to use the cleanup functions `CleanupDeletePushL()`, `CleanupClosePushL()` and `CleanupReleasePushL()`, and `CleanupArrayDeletePushL()`.
MessageQueueExample	Shows the use of the message queue in interprocess communication.
pubsub	Shows the Publish and Subscribe IPC mechanism.
rbufexample	Shows how to use the resizable buffer descriptor class RBuf.
SecureServer	Shows how to use the policy server framework.
tcharexample	Shows how to use the single character class, TChar, and its derived classes.
TLS1	Shows the use of thread local storage (TLS) in a DLL, that is set and accessed from a separate executable.
ThreadRendezvous	Shows the principle of synchronisation using the thread rendezvous technique.
BasicTimer	Shows the asynchronous timer class RTimer
Periodic	Shows the differences between a periodic and a heartbeat timer.
resourcemanager	Shows how to use the Power Resource Manager framework.
SmpExample	Shows the differences between code running in a unicore environment and in a multiprocessor environment.
SemaphoreExample	Shows how to use semaphores for a multithreading application.

Messaging Middleware

Name	Description
TextMTM	Several example projects that show how to use the Messaging APIs.
SearchSortExample	Shows how to use the enhanced search and sort API for message stores.
BIOMessageMgr	Shows BIO messaging and parsing the BIO message.
SendAs2Example	Shows how to use the SendAs v2 protocol for sending messages.

Messaging Applications

Name	Description
smsexample	Shows how to send and receive SMS messages using the Messaging Framework APIs.
Imap4Pop3Example	Shows how to create SMTP (Simple Mail Transfer Protocol) and POP (Post Office Protocol) accounts to send and receive emails. Shows how to create SMTP and IMAP (Internet Message Access Protocol) accounts to send and receive emails.

Name

Description

smsexample

Shows how to send and receive SMS messages using the Messaging Framework APIs.

Imap4Pop3Example

Shows how to create SMTP (Simple Mail Transfer Protocol) and POP (Post Office Protocol) accounts to send and receive emails.

Shows how to create SMTP and IMAP (Internet Message Access Protocol) accounts to send and receive emails.

Multimedia

Multimedia APIs and Frameworks

Name	Description
ICLCodec	Shows how to implement encoder and decoder plug-ins for the Image Converter Library.
ImageConverter	Shows how to convert between standard graphics formats to and from CFbsBitmap s, and how to rotate, flip, and zoom images.
CameraExample	Shows how to use the Camera API to capture and control images.

Multimedia Middleware

Multimedia Middleware Frameworks

Name	Description
AudioClientEx	Shows how to use the Multimedia Framework's client audio interfaces to play and record audio.
MmfExCodec	Shows how to implement a codec plug-in for the Multimedia Framework to convert media data.
MmfRAWFormat	Shows how to implement format encoder and decoder plug-ins for the Multimedia Framework.
MmfExSinkSource	Shows how to implement sink and source plug-ins for the Multimedia Framework.

Networking Services

Network Protocols

Name	Description
EchoClientEngine	The engine for the TCP/IP echo client example.
EchoClientUI	The user interface for the TCP/IP echo client example.

Network Security

Name	Description
SecureSockets	Shows how to create and use a secure sockets (SSL/TLS) connection.

PC Tools

Secure Software Install Tools

Name	Description
HelloWorld	Shows how to create a simple installation file for an application.
HelloWorld	Shows how to create an installation file for a multilingual application.

Persistent Data Services

Persistent Storage

Name	Description
Basics	Shows how to create and use a database using DBMS.
SqlExample	Shows how to use the SQL API to create and query an SQL database.
CentRepExample	Shows how to use the central repository to store settings and request notification of changes.
WriteDirectFS	Shows how to persist objects using a direct file store and a root stream.
WritePermFS1	Shows how to write a network of objects to a permanent file store then read them back in again.
WritePermFS2	Shows how to create and use a permanent file store.
StreamInStore	Shows how to externalize objects to a single stream in a non-persistent store.
WriteToMany	Shows how to write a network of objects to more than one stream in a direct file store, and to defer the loading of an object from the store into memory.
WriteToEmbedded	Shows how an object is externalized to a store embedded within a permanent file store.
StoreMap	Shows how to stream a compound object to multiple streams using a store map.
SimpleClass	Shows streaming a simple class to and from a single stream.
CompoundClass	Shows streaming a compound class to and from a single stream
FeatMngrExample	Shows the use of Feature Manager APIs for dynamic management of features.

PIM

PIM Application Services

Name	Description
CalExample	Shows how to create and use a calendar file.
ContactViews	Shows how to use various contact view classes to create a view of a contact database.

PIM Application Support

Name	Description
CalconExample	Shows how to convert between Gregorian and Chinese dates.
VersitExample	Shows how to import and export vCards.

Text & Localisation

Font & Text Services

Name	Description
TxtShell	Shows global and rich text formatting, text styles and changing the view layout.

System GUI Framework

Look-and-Feel Agnostic UI Foundation

Name	Description
AnimExample	Shows how to create and play basic and sprite animations.
ControlFramework	Shows how a view handles pointer and key events.
Custom	Shows how to create simple and compound control classes.

Parent topic: Example code