SFBvCard

Wrapper Class for the IvCard interface.

#include <SFBvCard.h.hpp>

class SFBvCard : public SFBvObject;

SFMTYPEDEFWRAPPER(SFBvCard)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API IvCard

Member

Public Functions
`SFCError`	AddProperty( `SFBvPropertySmpConstRef` property ) Add a Property to the vCard.
`SFCError`	GetNumberOfProperties( `AEEVProperty` propertyId , `SInt32Ptr` num ) Return the number of recurring properties for a particular property id.
`SFCError`	GetPropertyAtIndex( `AEEVProperty` propertyId , `SInt32` index , `SFBvPropertySmpPtr` property ) Get the property based on ID.
static `SFBvCardSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBvCard instance.
static `SFBvCardSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBvCard instance.
`SFCError`	RemoveProperty( `SFBvPropertySmpConstRef` property ) Remove the specified property.
`SFCError`	GetObjectType( `AEECLSID *` type ) (inherits from SFBvObject) Return the AEECLSID of the current object type.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBvCard::AddProperty

Add a Property to the vCard.

[ public ]
SFCError AddProperty(
    SFBvPropertySmpConstRef property   // the property to be added
);

Reference

BREW API IvCard_AddProperty

SFBvCard::GetNumberOfProperties

Return the number of recurring properties for a particular property id.

[ public ]
SFCError GetNumberOfProperties(
    AEEVProperty propertyId   // property ID, for which we want to check the number of occurrences
    SInt32Ptr num             // contains the number of properties for that particular property id
);

Reference

BREW API IvCard_GetNumberOfProperties

SFBvCard::GetPropertyAtIndex

Get the property based on ID.

[ public ]
SFCError GetPropertyAtIndex(
    AEEVProperty propertyId       // the ID of the property
    SInt32 index                  // the index at which the object has to be retrieved, the index is zero based
    SFBvPropertySmpPtr property   // pointer to smart pointer to SFBvProperty object.
);

Reference

BREW API IvCard_GetPropertyAtIndex

SFBvCard::NewInstance

Create a new SFBvCard instance.

[ public, static ]
SFBvCardSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBvCardSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBvCard::RemoveProperty

Remove the specified property.

[ public ]
SFCError RemoveProperty(
    SFBvPropertySmpConstRef property   // smart pointer SFBvProperty object that has to be removed
);

Reference

BREW API IvCard_RemoveProperty