SFBxOpts

Wrapper Class for the IxOpts interface.

#include <SFBxOpts.h.hpp>

class SFBxOpts : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBxOpts)

Inheritance diagram

Version

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

Reference

BREW API IxOpts

Member

Public Functions
`SFCError`	AddOpt( `xOpt *` opts ) Adds the list of xOpt's to the current option set.
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `xOpt *` opt ) Find a xOpt in the list of xOpts in index matching id.
static `SFBxOptsSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBxOpts instance.
static `SFBxOptsSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBxOpts instance.
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) remove the nIndex'th xOpt matching nOptId
`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.

SFBxOpts::AddOpt

Adds the list of xOpt's to the current option set.

[ public ]
SFCError AddOpt(
    xOpt * opts   // array of xOpt structs, terminated by a xOpt with nId set to XOPT_END
);

Return value

AEE_SUCCESS if the options could be added successfully
AEE_ENOMEMORY if enough memory couldn't be allocated

Reference

BREW API IxOpts_AddOpt

SFBxOpts::GetOpt

Find a xOpt in the list of xOpts in index matching id.

[ public ]
SFCError GetOpt(
    SInt32 id      // id of the option to find in the options list, XOPT_ANY returns the nIndexth option, if there is one... 
    SInt32 index   // which (if there are multiple xOpts of the same id) to get nIndex counts from most recently AddOpt()ed option, it's zero-based
    xOpt * opt     // where to stick the found xOpt  
);

Return value

AEE_SUCCESS: if the options could be added successfully
AEE_EFAILED: if the specified xOpt couldn't be found
AEE_EBADPARM: if pItem is NULL

Reference

BREW API IxOpts_GetOpt

SFBxOpts::NewInstance

Create a new SFBxOpts instance.

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

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

SFBxOpts::RemoveOpt

remove the nIndex'th xOpt matching nOptId

[ public ]
SFCError RemoveOpt(
    SInt32 id      // id of the option to remove from the options list 
    SInt32 index   // which (if there are multiple xOpts of the same id) to remove nIndex counts from most recently AddOpt()ed option 
);

Return value

AEE_SUCCESS: if the options could be added successfully
AEE_EFAILED: if the specified xOpt couldn't be found

Reference

BREW API IxOpts_RemoveOpt