sbVariantUtilsLib.h File Reference

Songbird Variant Utility Definitions. More...

#include <nsCOMPtr.h>
#include <nsIVariant.h>
Include dependency graph for sbVariantUtilsLib.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

nsQueryInterface do_VariantQueryInterface (nsIVariant *aVariant)
 
nsQueryInterfaceWithError do_VariantQueryInterface (nsIVariant *aVariant, nsresult *aError)
 
nsresult sbVariantsEqual (nsIVariant *aVariant1, nsIVariant *aVariant2, PRBool *aEqual)
 

Detailed Description

Songbird Variant Utility Definitions.

Definition in file sbVariantUtilsLib.h.

Function Documentation

nsQueryInterface do_VariantQueryInterface ( nsIVariant *  aVariant)
inline

Return a QI'd object for the contents of the variant specified by aVariant. This function implements do_QueryInterface for the contents of the variant.

Parameters
aVariantVariant for which to get QI'd object.
Returns
QI'd variant content.

Definition at line 70 of file sbVariantUtilsLib.h.

nsQueryInterfaceWithError do_VariantQueryInterface ( nsIVariant *  aVariant,
nsresult *  aError 
)
inline

Return a QI'd object for the contents of the variant specified by aVariant and return the error result in aError. This function implements do_QueryInterface for the contents of the variant.

Parameters
aVariantVariant for which to get QI'd object.
aErrorReturned error result.
Returns
QI'd variant content.

Definition at line 95 of file sbVariantUtilsLib.h.

nsresult sbVariantsEqual ( nsIVariant *  aVariant1,
nsIVariant *  aVariant2,
PRBool *  aEqual 
)

Return true in aEqual if the variant specified by aVariant2 is equal to the variant specified by aVariant1; otherwise, return false. For the comparison, aVariant2 is converted to match the data type of aVariant1. If aVariant1 is an integer, and aVariant2 is a string of the form "0xde10", aVariant2 will be converted as a hexadecimal.

Parameters
aVariant1Variants to compare.
aVariant2
aEqualReturned true if variants are equal.

Definition at line 160 of file sbVariantUtilsLib.cpp.

Here is the call graph for this function: