Websites Navigation:
Airbit
|
Shop
|
m-shell.net
Languages:
EN
|
DE
Home
Downloads
Products
Make SIS
Documentation
Forum
Blog
Contact
Prev: Item Descriptions
Module
mdoc
: Documentation Generator
This module is part of the
mDocumenter
package which can be downloaded from
www.m-shell.net/download.aspx
.
Please refer to the
mdoc
of module
mdoc
for reference information.
Next: Scanning
m
Sources
© 2004-2011
airbit
AG, CH-8008 Zürich
Document AB-M-TOO-887
Navigation
m add-ons (mdoc)
Index
Manuals
[Collapse All]
m Mobile Shell: Library, V. 3.07
Introduction
Module and Function Availability
User Permissions
Path and File Names
Fundamental Modules
Module
: Builtin Functions and Constants
.append
.cd
.char
.cls
.code
.collate
.date
.equal
.delete
.hexnum
.hexstr
.index
.isarray
.isboolean
.isfunction
.isinst
.isinstfunc
.isnative
.isnum
.isstr
.keys
.len
.lower
.num
.replace
.rindex
.sleep
.split
.str
.substr
.trim
.upper
Constants
Module
array
: Array Functions
array.concat
array.copy
array.create
array.fill
array.index
array.insert
array.isort
array.leindex
array.new
array.remove
array.rindex
array.sort
Constants
Module
encoding
: Standard Encodings
encoding.frombase64
encoding.fromhex
encoding.fromhex16
encoding.fromhtml
encoding.fromuri
encoding.fromutf8
encoding.tobase64
encoding.tohex
encoding.tohex16
encoding.tohtml
encoding.touri
encoding.toutf8
Module
files
: File and Directory Access
files.attr
files.copy
files.delete
files.edit
files.exists
files.mkdir
files.move
files.parse
files.rename
files.rmdir
files.roots
files.scan
files.send
files.size
files.time
files.wait
Module
io
: File and Stream Input/Output
io.append
io.avail
io.close
io.ces
io.copy
io.create
io.flush
io.format
io.open
io.print
io.printf
io.println
io.read
io.readln
io.readm
io.seek
io.size
io.timeout
io.wait
io.write
io.writeln
io.writem
Module
memio
: In-Memory Streams and Buffers
memio.clear
memio.delete
memio.get
memio.insert
memio.new
Module
system
: System Related Functions
system.gc
system.hal
system.lock
system.mem
system.reboot
system.shutdown
system.verbosegc
Constants
Module
time
: Time and Date Functions
time.dayofweek
time.get
time.set
time.num
time.str
time.utc
time.weekofyear
Module
zip
: ZIP Archives
zip.close
zip.extract
zip.open
zip.scan
User Interface
Module
graph
: Screen Graphics
Coordinates
Colors
Alpha Blending
Simple Example
graph.alpha
graph.bg
graph.brush
graph.circle
graph.clear
graph.clip
graph.ellipse
graph.font
graph.full
graph.get
graph.hide
graph.icon
graph.line
graph.pen
graph.poly
graph.put
graph.rect
graph.save
graph.scale
graph.screen
graph.show
graph.size
graph.text
Module
light
: Control Device Lighting
light.blink
light.off
light.on
light.reset
light.state
light.targets
light.wait
Module
ui
: User Interface Functions
ui.busy
ui.cmd
ui.confirm
ui.error
ui.fonts
ui.form
ui.idletime
ui.keys
ui.label
ui.large
ui.list
ui.menu
ui.mfont
ui.mode
ui.msg
ui.pfonts
ui.ptr
ui.query
ui.save
ui.text
Constants
Module
vibra
: Vibration Control
vibra.off
vibra.on
Mathematics
Module
bigint
: Arbitrarily Large Integers
bigint.abs
bigint.add
bigint.cmp
bigint.div
bigint.mod
bigint.mul
bigint.neg
bigint.new
bigint.num
bigint.pow
bigint.str
bigint.sub
Module
math
: Mathematical Functions
math.abs
math.acos
math.asin
math.atan
math.ceil
math.cos
math.exp
math.floor
math.isinf
math.isnan
math.log
math.pow
math.random
math.round
math.sin
math.sqrt
math.tan
math.trunc
Constants
Personal Data
Module
agenda
: Agenda Database
Agenda Fields
Agenda Entry Flags
Synchronization mode
Repetitive Entries
agenda.add
agenda.delete
agenda.find
agenda.findall
agenda.get
agenda.set
Module
contacts
: Contacts Database
Contact Fields
contacts.add
contacts.delete
contacts.find
contacts.findnr
contacts.get
contacts.labels
contacts.new
contacts.own
contacts.set
Communications
Module
bt
: Bluetooth Communication
Terminology
Connections Are Streams
Simple Example
bt.accept
bt.adr
bt.chan
bt.conn
bt.name
bt.scan
bt.select
bt.start
bt.stop
bt.timeout
bt.uuid
bt.visible
Module
comm
: Serial Communications
Serial Ports Are Streams
comm.config
comm.link
comm.open
comm.signal
comm.units
Module
net
: TCP/IP Networking
Connections Are Streams
Internet Access Points
net.accept
net.adr
net.cert
net.conn
net.iap
net.iaps
net.listen
net.local
net.name
net.remote
net.shut
net.start
net.stop
net.timeout
Messaging
Module
mail
: E-Mail Messages
Example
mail.boxes
mail.conn
mail.delete
mail.from
mail.get
mail.inbox
mail.index
mail.load
mail.open
mail.send
mail.set
mail.sync
Module
mms
: Multimedia Messages
mms.delete
mms.get
mms.inbox
mms.open
mms.receive
mms.send
mms.set
Module
msg
: Generic Message Access
msg.delete
msg.move
msg.open
msg.scan
Constants
Module
obex
: Object Exchange Client
obex.close
obex.conn
obex.get
obex.path
obex.put
obex.timeout
obex.who
Constants
Module
sms
: Short Messages
sms.delete
sms.get
sms.inbox
sms.receive
sms.send
sms.set
Multimedia
Module
audio
: Playing and Recording Sounds
audio.beep
audio.busy
audio.close
audio.cut
audio.dtmf
audio.len
audio.open
audio.play
audio.pos
audio.record
audio.stop
audio.volume
audio.wait
Module
cam
: Onboard Camera
cam.bright
cam.contrast
cam.index
cam.off
cam.on
cam.sizes
cam.take
cam.view
Constants
Module
cam2
: Extended Camera Functions
cam2.bright
cam2.contrast
cam2.exposure
cam2.flash
cam2.focus
cam2.icon
cam2.index
cam2.off
cam2.on
cam2.take
cam2.view
cam2.zoom
Constants
Module
video
: Playing and Recording Videos
Playing Videos
Recording Videos
video.busy
video.close
video.create
video.hide
video.open
video.play
video.pos
video.record
video.setup
video.show
video.stop
video.volume
video.view
video.wait
Constants
Telephony
Module
gsm
: GSM information
gsm.cid
gsm.net
gsm.new
gsm.signal
Constants
Module
phone
: Phone Calls
phone.answer
phone.dial
phone.hangup
phone.ms
phone.new
phone.state
Constants
Applications and Processes
Module
app
: Application Control
app.capture
app.find
app.hide
app.key
app.open
app.runs
app.send
app.show
app.start
app.stop
app.view
Constants
Module
async
: Asynchronous Function Streams
Restrictions
async.abort
async.call
async.new
async.pending
async.result
Module
proc
:
m
Processes
proc.arg
proc.close
proc.find
proc.hide
proc.pipe
proc.run
proc.runs
proc.show
proc.stop
Environment
Module
accel
: Accelerator Measurements
accel.get
accel.new
Module
compass
: Magnetometer Measurements
compass.get
compass.new
Module
location
: Location Information
location.course
location.get
location.last
location.sats
location.source
location.stop
location.str
Cryptography
Module
digest
: Message Digests
digest.add
digest.add16
digest.clear
digest.get
digest.new
m Mobile Shell: Reference, V. 3.07
Introduction
Language
Data Types
Comments
Literals
Number Literals
String Literals
Boolean Literals
Function Literals
Null Literal
Variables
Arrays
Associative Arrays
Expressions
Operands
Operation Precedence
Arithmetic Operators
Bitwise Operators
Concatenation Operator
Comparison Operators
Class Instance Tests
Boolean Operators
Statements
Assignments
Increment
If Statement
While Statement
Do-Until Statement
For Statement
Case Statement
Break Statement
Return Statement
print Statement
Functions
Optional Parameters
Forward Declaration
Function References
Modules
Module Search Order
Module Prefixes
Module Version
Optional Modules
Exceptions
Catching Exceptions
Throwing Exceptions
Object Oriented Programming
Classes and Class Instances
Variable Declarations, revisited
Function Declarations, revisited
Class Fields
Class Functions
Inheritance, Sub- and Superclasses
Instance Creation and Constructors
The .Instance Base Class
Instance Function References
Source Structure
Interactive Shells
Simplified Syntax for Interactive Use
Shell Builtin Functions
.cp
.del
.dir
.edit
.exit
.md
.mv
.rd
.ren
.run
.send
.type
Producing Standalone Applications
Input Files
Settings
Properties & User Permissions
m
and Symbian Platform Security
Capabilities
Open Signing Online
Open Signing with a DevCert
Obtaining a DevCert
Signing
m
with the DevCert
Appendix
Exception Tags
Environment Exceptions
Programming Exceptions
Internal Error Exceptions
Reserved words
m Properties File
m Mobile Shell: Tutorial & User Guide, V. 3.07
Introduction
About
m
Tutorial Structure
Quick Start Guide
Installing
m
A Sample Script
A Sample Shell Session
The
m
Application
The Script List
Searching Scripts
The Console
Script Files
Sending and Receiving
m
Files
Compiling
m
Scripts
Producing Standalone Applications
The Editor
Scrolling
Find and Replace
The Properties Dialog
The Permissions Dialog
m
Programming
Basic Arrays
Associative Arrays
Accessing SMS
Editing Data
Making it a Function
Combining SMS and User Interface
Reading and Writing Files
Making it a Module
Conclusion
m
Help System
Invoking help
Navigating through patterns
m
Runtime Errors (Exceptions)
m
Library Overview
Installation Guide
Installation
Registration
m Mobile Shell: Supervisor & Viewer, V. 3.07
Introduction
Installation
The
m
Supervisor
The Supervisor Dialog
SMS Control
Supervisor Properties File
The
m
Viewer
m Mobile Shell: Programming Tools, V. 3.07
Introduction
Debugging Support
Module
debug
: Runtime Debugging
Module, Class, Function and Variable Indices
Code Positions and Frames
Example
debug.breakp
debug.close
debug.ccount
debug.cindex
debug.cinfo
debug.compile
debug.fcount
debug.go
debug.open
debug.pause
debug.pos
debug.state
debug.vcount
debug.vglobal
debug.vindex
debug.vinfo
debug.vlocal
debug.wait
Generating Documentation
Item Descriptions
Module
mdoc
: Documentation Generator
Scanning
m
Sources
Module
mscanner
: Source Scanner
m Mobile Shell: Native Module Interface, V. 3.07
Introduction
DLL Structure
World Server Example
Module Class
World Server Example
Module Versioning
Defining Module Members
World Server Example, Continued
Implementing Functions
World Server Example, Continued
DLL Entry Points
World Server Example, Continued
m
Runtime System
m
Data Types and Values
Scalars
World Server Example, Continued
Strings
World Server Example, Continued
Arrays
World Server Example, Continued
Creating, Installing and Testing the module DLL
Compiling and Linking
World Server Example, Continued
Installing
Symbian 2nd Edition
Symbian 3rd/5th Edition
Testing
Advanced Concepts
Alarm Server Example
User Permissions
Alarm Server Example, Continued
Asynchronous Request Handling
Alarm Server Example, Continued
Timeouts
Alarm Server Example, Continued
Native Objects
Native Streams
Native Icons
Memory Allocation
Module Loading and Initialization
Restrictions
NMI SDK
Installation
Files
Platform Security
mShell Home
>
Documentation
> Manuals
