mozilla

nsIDialogParamBlock

An interface to pass strings, integers and nsISupports to a dialog.
Inherits from: nsISupports Last changed in Gecko 1.7

Method overview

PRInt32 GetInt( in PRInt32 inIndex );
wstring GetString( in PRInt32 inIndex );
void SetInt( in PRInt32 inIndex, in PRInt32 inInt );
void SetNumberStrings( in PRInt32 inNumStrings );
void SetString( in PRInt32 inIndex, in wstring inString);

Attributes

Attribute Type Description
objects nsIMutableArray A place where you can store an nsIMutableArray to pass nsISupports.

Methods

GetInt()

Get a previously set integer.

PRInt32 GetInt(
  in PRInt32 inIndex 
);
Parameters
inIndex
The index of the integer to get. Must be in the range 0..7.
Return value

The previously set integer, or 0 if no integer has been previously set at that index.

GetString()

Get a previously set string.

wstring GetString(
  in PRInt32 inIndex 
);
Parameters
inIndex
The index of the string to get. Must be in the range 0..15 unless SetNumberStrings was called.
Return value

The string at the given index, or the empty string if no string has previously been set at that index.

SetInt()

void SetInt(
  in PRInt32 inIndex,
  in PRInt32 inInt 
);
Parameters
inIndex
The index of the integer to set. Must be in the range 0..7.
inInt
The integer to set at the given index.

SetNumberStrings()

Set the maximum number of strings to pass. Default is 16. Use before setting any string (if you want to change it from the default). This method can only be called once.

void SetNumberStrings(
  in PRInt32 inNumStrings 
);
Parameters
inNumStrings
The new maximum number of strings to pass.

SetString()

void SetString(
  in PRInt32 inIndex,
  in wstring inString
);
Parameters
inIndex
The index of the string to set. Must be in the range 0..15 unless SetNumberStrings was called.
inString
The string to set at the given index.

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, trevorh, Neil
Last updated by: Sheppy,