SFBvObjectParser

Wrapper Class for the IvObjectParser interface.

#include <SFBvObjectParser.h.hpp>

class SFBvObjectParser : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBvObjectParser)

Inheritance diagram

Version

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

Reference

BREW API IvObjectParser

Member

Public Functions
`SFCError`	GetBufferFromIvObject( `SFBvObjectSmpConstRef` object , `ACharPtr` buffer , `SInt32` size , `SInt32Ptr` sizereq ) Return the null terminated data buffer generated from passed in SFBvObject.
`SFCError`	GetBufferFromIvObject( `SFBvObjectSmpConstRef` object , `SFXBufferPtr` buffer ) Return the null terminated data buffer generated from passed in SFBvObject.
`SFCError`	GetNumberOfParsedObjects( `SInt32Ptr` num , `AEECLSID *` id ) Let the user know the number of SFBvObjects created while parsing.
`SFCError`	GetObjectAtIndex( `SInt32` index , `SFBvObjectSmpPtr` object ) Return a newly instantiated SFBvObject.
static `SFBvObjectParserSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBvObjectParser instance.
static `SFBvObjectParserSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBvObjectParser instance.
`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.

SFBvObjectParser::GetBufferFromIvObject

Return the null terminated data buffer generated from passed in SFBvObject.

[ public ]
SFCError GetBufferFromIvObject(
    SFBvObjectSmpConstRef object   // smart pointer to the SFBvObject class for which the buffer has to be generated
    ACharPtr buffer                // pointer to the generated buffer
    SInt32 size                    // size of the buffer
    SInt32Ptr sizereq              // required buffer size to hold the data stream
);

[ public ]
SFCError GetBufferFromIvObject(
    SFBvObjectSmpConstRef object   // smart pointer to the SFBvObject class for which the buffer has to be generated
    SFXBufferPtr buffer            // pointer to the generated buffer
);

Reference

BREW API IvObjectParser_GetBufferFromIvObject

SFBvObjectParser::GetNumberOfParsedObjects

Let the user know the number of SFBvObjects created while parsing.

[ public ]
SFCError GetNumberOfParsedObjects(
    SInt32Ptr num   // holds number of objects created
    AEECLSID * id   // will let the user know of what kind of buffer has been parsed
);

Reference

BREW API IvObjectParser_GetNumberOfParsedObjects

SFBvObjectParser::GetObjectAtIndex

Return a newly instantiated SFBvObject.

[ public ]
SFCError GetObjectAtIndex(
    SInt32 index              // index at which users want to retrieve the object, the index is zero based
    SFBvObjectSmpPtr object   // smart pointer to the SFBvObject object that has to created
);

Reference

BREW API IvObjectParser_GetObjectAtIndex

SFBvObjectParser::NewInstance

Create a new SFBvObjectParser instance.

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

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