Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsICmdLineService Interface Reference

import "nsICmdLineService.idl";

Inheritance diagram for nsICmdLineService:
Inheritance graph
[legend]
Collaboration diagram for nsICmdLineService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void initialize (in long argc, out string argv)
 initialize Used to pass the original argv/argc from main() Warning: This will hold a reference to the original argv passed into Initialze();
string getCmdLineValue (in string argv)
 getCmdLineValue returns the 2nd parameter, if any, to the parameter passed in For example, getCmdLineValue "-edit" will return any url that came after the -edit parameter
nsICmdLineHandler getHandlerForParam (in string param)
 Get the command line handler for the given parameter.

Public Attributes

readonly attribute string URLToLoad
 URLToLoad The URL to load as passed to the command line.
readonly attribute string programName
 programName
readonly attribute long argc
 argc The number of parameters passed in on the command line
readonly attribute charArray argv
 argv returns a direct reference to the parameter array passed in to initialize() - do NOT dereference this array!

Detailed Description

Definition at line 44 of file nsICmdLineService.idl.


Member Function Documentation

getCmdLineValue returns the 2nd parameter, if any, to the parameter passed in For example, getCmdLineValue "-edit" will return any url that came after the -edit parameter

Get the command line handler for the given parameter.

Parameters:
param- can be any parameter, with or without leading "-" such as "-mail" or "edit" - Pass in a null string if you want the "default" handler

initialize Used to pass the original argv/argc from main() Warning: This will hold a reference to the original argv passed into Initialze();


Member Data Documentation

argc The number of parameters passed in on the command line

Definition at line 78 of file nsICmdLineService.idl.

argv returns a direct reference to the parameter array passed in to initialize() - do NOT dereference this array!

Definition at line 85 of file nsICmdLineService.idl.

programName

  

Definition at line 72 of file nsICmdLineService.idl.

URLToLoad The URL to load as passed to the command line.

Definition at line 66 of file nsICmdLineService.idl.


The documentation for this interface was generated from the following file: