Code snippet template

Comments

(no comments yet)

Log in or Join to leave comments.

Article Metadata

---

Article

Created: User:Technical writer 1 (25 Jan 2008)

Last edited: hamishwillee (02 Aug 2012)

Delete the guidance text written in italics.

Overview

Delete the texts that do not apply.

This snippet can be self-signed.

[or]

This snippet requires XXX capabilities. Self-signing is not possible because a Developer Certificate is needed.

[or]

This snippets requires XXX capabilities. Self-signing is not possible because a Developer Certificate, Publisher ID, and device manufacturer approval are required.

Preconditions

In complex cases you may need to provide information on the framework needed in order to implement and use the code snippet. For example, a Bluetooth connection must be established in order to use the code snippet "send a file via Bluetooth OBEX". You can refer to an already existing code example.

MMP file (optional)

The following capabilities and libraries are required:

CAPABILITY       
 
LIBRARY          
 
LIBRARY

Header file

Not the complete file but relevant code blocks.

 code

Source file

Not the complete file but relevant code blocks.

You do not need to provide complete error handling but it should be commented as TODO for developers.

 code

Postconditions

Explain what the code snippet is expected to do.

Test application and other attachments (optional)

The attachments should be provided with the visible info page (Categories need to be defined, the attached file must be uploaded to Wiki, and internal Wiki links must be used). Every attachment should have its own page (however, a ZIP package can be used for multiple source code files).