SFBvCalObject

Wrapper Class for the IvCalObject interface.

#include <SFBvCalObject.h.hpp>

class SFBvCalObject : public SFBvObject;

SFMTYPEDEFWRAPPER(SFBvCalObject)

Inheritance diagram

Version

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

Reference

BREW API IvCalObject

Member

Public Functions
`SFCError`	AddObject( `SFBvCalObjectSmpConstRef` calendar ) Add the passed in Object.
`SFCError`	AddProperty( `SFBvPropertySmpConstRef` property ) Add a property.
`SFCError`	GetNumberOfObjects( `AEECLSID` id , `SInt32Ptr` num ) Return the specified number of objects attached to this IvCalObj for the specified object id.
`SFCError`	GetNumberOfProperties( `AEEVProperty` propertyId , `SInt32Ptr` num ) Return the number of properties.
`SFCError`	GetObjectAtIndex( `SInt32` index , `AEECLSID` id , `SFBvCalObjectSmpPtr` calendar ) Return the IvCalObj at specified index for that class id.
`SFCError`	GetObjectId( `AEECLSID *` id ) Return the current object AEECLSID.
`SFCError`	GetPropertyAtIndex( `AEEVProperty` propertyId , `SInt32` index , `SFBvPropertySmpPtr` property ) Get the SFBvProperty object at the specified index.
static `SFBvCalObjectSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBvCalObject instance.
static `SFBvCalObjectSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBvCalObject instance.
`SFCError`	RemoveObject( `SFBvCalObjectSmpConstRef` calendar ) Remove the given object.
`SFCError`	RemoveProperty( `SFBvPropertySmpConstRef` property ) Remove the given SFBvProperty object.
`SFCError`	SetVersion( `AEEVCalVersion` calVersion ) Set the version of the object.
`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.

SFBvCalObject::AddObject

Add the passed in Object.

[ public ]
SFCError AddObject(
    SFBvCalObjectSmpConstRef calendar   // object that has to be added
);

Reference

BREW API IvCalObject_AddObject

SFBvCalObject::AddProperty

Add a property.

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

Reference

BREW API IvCalObject_AddProperty | SFBvProperty

SFBvCalObject::GetNumberOfObjects

Return the specified number of objects attached to this IvCalObj for the specified object id.

[ public ]
SFCError GetNumberOfObjects(
    AEECLSID id     // the object AEECLSID which user wants to know
    SInt32Ptr num   // contains the number of objects
);

Reference

BREW API IvCalObject_GetNumberOfObjects

SFBvCalObject::GetNumberOfProperties

Return the number of properties.

[ 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 IvCalObject_GetNumberOfProperties

SFBvCalObject::GetObjectAtIndex

Return the IvCalObj at specified index for that class id.

[ public ]
SFCError GetObjectAtIndex(
    SInt32 index                   // index at which the object has to be retrieved from, the inde is zero based
    AEECLSID id                    // the object Id that has to be retrieved
    SFBvCalObjectSmpPtr calendar   // to hold the returned object
);

Reference

BREW API IvCalObject_GetObjectAtIndex

SFBvCalObject::GetObjectId

Return the current object AEECLSID.

[ public ]
SFCError GetObjectId(
    AEECLSID * id   // current object ID
);

Reference

BREW API IvCalObject_GetObjectId

SFBvCalObject::GetPropertyAtIndex

Get the SFBvProperty object at the specified index.

[ public ]
SFCError GetPropertyAtIndex(
    AEEVProperty propertyId       // property ID, for which we want to retrieve the object
    SInt32 index                  // index at which the value has to be retirieved, the given nIndex is zero based
    SFBvPropertySmpPtr property   // smart pointer to the property object
);

Reference

BREW API IvCalObject_GetPropertyAtIndex

SFBvCalObject::NewInstance

Create a new SFBvCalObject instance.

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

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

SFBvCalObject::RemoveObject

Remove the given object.

[ public ]
SFCError RemoveObject(
    SFBvCalObjectSmpConstRef calendar   // object that has to be removed
);

Reference

BREW API IvCalObject_RemoveObject

SFBvCalObject::RemoveProperty

Remove the given SFBvProperty object.

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

Reference

BREW API IvCalObject_RemoveProperty

SFBvCalObject::SetVersion

Set the version of the object.

[ public ]
SFCError SetVersion(
    AEEVCalVersion calVersion   // version to be set
);

Reference

BREW API IvCalObject_SetVersion