SFBWeb

Wrapper Class for the IWeb interface.

#include <SFBWeb.h.hpp>

class SFBWeb : public SFBWebOpts;

SFMTYPEDEFWRAPPER(SFBWeb)

Inheritance diagram

Version

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

Reference

BREW API IWeb

Member

Public Functions
`Void`	GetResponse( `SFBWebRespSmpPtr` webResp , `SFXCallbackPtr` callback , `ACharConstPtr` url , `...` ) Begin a web transaction by establishing the resources and locations needed for a web response to be received.
`Void`	GetResponseV( `SFBWebRespSmpPtr` webResp , `SFXCallbackPtr` callback , `ACharConstPtr` url , `WebOptPtr` opts ) Begin a web transaction by establishing the resources and locations needed for a web response to be received. It is a vector form of GetResponse.
`Void`	GetResponseV( `SFBWebRespSmpPtr` webResp , `SFXCallbackPtr` callback , `SFXAnsiStringConstRef` url , `WebOptPtr` opts ) Begin a web transaction by establishing the resources and locations needed for a web response to be received. It is a vector form of GetResponse.
static `SFBWebSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new instance of SFBWeb class.
static `SFBWebSmp`	NewInstance( `AEECLSID` clsid = AEECLSID_WEB , `SFCErrorPtr` exception = null ) Create a new instance of SFBWeb class.
`SFCError`	AddOpt( `WebOptPtr` opts ) (inherits from SFBWebOpts) Add the list of WebOpts to the current web option set.
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `WebOptPtr` opt ) (inherits from SFBWebOpts) Get a WebOpt in the list of WebOpts in SFBWebOpts instance matching OptId in.
`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.
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) (inherits from SFBWebOpts) Remove the nIndex'th WebOpt matching OptId.
`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 a specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for a specified ClassID's interface using the SFBQuery instance.

SFBWeb::GetResponse

Begin a web transaction by establishing the resources and locations needed for a web response to be received.

[ public ]
Void GetResponse(
    SFBWebRespSmpPtr webResp   // pointer to SFBWebResp interface pointer, where to stick answer.
                               // object must be available during the callback longevity.
                               // when finished, user have to free it
    SFXCallbackPtr callback    // where to call when answer is ready
    ACharConstPtr url          // requested document URL
    ...                        // a variable list of WebOpt id/value pairs, terminated with WEBOPT_END
);

Reference

BREW API IWEB_GetResponse

SFBWeb::GetResponseV

Begin a web transaction by establishing the resources and locations needed for a web response to be received. It is a vector form of GetResponse.

[ public ]
Void GetResponseV(
    SFBWebRespSmpPtr webResp   // pointer to SFBWebResp interface pointer, where to stick answer 
    SFXCallbackPtr callback    // where to call when answer is ready 
    ACharConstPtr url          // requested document
    WebOptPtr opts             // an array of WebOpts, terminated with WEBOPT_END
);

[ public ]
Void GetResponseV(
    SFBWebRespSmpPtr webResp    // pointer to SFBWebResp interface pointer, where to stick answer 
    SFXCallbackPtr callback     // where to call when answer is ready 
    SFXAnsiStringConstRef url   // requested document
    WebOptPtr opts              // an array of WebOpts, terminated with WEBOPT_END 
);

Description

The argument webResp is the Pointer to the Pointer of SFBWebResp(Containing the response). Object must be available during the callback longevity. When finished, user have to free it.

Reference

BREW API IWEB_GetResponseV | SFBWeb::GetResponse

SFBWeb::NewInstance

Create a new instance of SFBWeb class.

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

[ public, static ]
SFBWebSmp NewInstance(
    AEECLSID clsid = AEECLSID_WEB   // Class ID
    SFCErrorPtr exception = null    // Error
);