SFBWebOpts

Wrapper Class for the IWebOpts interface.

#include <SFBWebOpts.h.hpp>

class SFBWebOpts : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBWebOpts)

Inheritance diagram

Version

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

Reference

BREW API IWebOpts

Member

Public Functions
`SFCError`	AddOpt( `WebOptPtr` opts ) Add the list of WebOpts to the current web option set.
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `WebOptPtr` opt ) Get a WebOpt in the list of WebOpts in SFBWebOpts instance matching OptId in.
static `SFBWebOptsSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBWebOpts instance.
static `SFBWebOptsSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBWebOpts instance.
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) Remove the nIndex'th WebOpt matching OptId.
`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.

SFBWebOpts::AddOpt

Add the list of WebOpts to the current web option set.

[ public ]
SFCError AddOpt(
    WebOptPtr opts   // array of WebOpt structs, terminated by a WebOpt with nId set to WEBOPT_END
);

Reference

BREW API IWEBOPTS_AddOpt | WebOpt | SFBWebOpts::RemoveOpt | SFBWebOpts::GetOpt

SFBWebOpts::GetOpt

Get a WebOpt in the list of WebOpts in SFBWebOpts instance matching OptId in.

[ public ]
SFCError GetOpt(
    SInt32 id       // id of the option to find in the options list, WEBOPT_ANY returns the nIndexth option
    SInt32 index    // which (if there are multiple WebOpts of the same id) to get nIndex counts from 
                    // most recently AddOpt()ed option, it is zero-based
    WebOptPtr opt   // where to stick the found WebOpt 
);

Reference

BREW API IWEBOPTS_GetOpt | WebOpt | SFBWebOpts::AddOpt

SFBWebOpts::NewInstance

Create a new SFBWebOpts instance.

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

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

SFBWebOpts::RemoveOpt

Remove the nIndex'th WebOpt matching OptId.

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

Reference

BREW API IWEBOPTS_RemoveOpt | SFBWebOpts::AddOpt