PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBSourceUtil
Wrapper Class for the ISourceUtil interface.
#include <SFBSourceUtil.h.hpp>
class SFBSourceUtil : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBSourceUtil)

Inheritance diagram

 Inheritance diagram of SFBSourceUtilClass

Version

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

Reference

BREW API ISourceUtil

Member

Public Functions
SFCError AStreamFromSource( SFBSourceSmpConstRef src , SFBAStreamSmpPtr handle )
Make a new SFBAStream Interface object that gets data from a SFBSource Interface object.
SFBAStreamSmp AStreamFromSource( SFBSourceSmpConstRef src )
Make a new SFBAStream Interface object that gets data from a SFBSource Interface object.
SFCError GetLineFromSource( SFBSourceSmpConstRef src , SInt32 size , SFBGetLineSmpPtr handle )
Make a new SFBGetLine Interface object that gets data from a SFBSource Interface object.
SFBGetLineSmp GetLineFromSource( SFBSourceSmpConstRef src , SInt32 size )
Make a new SFBGetLine Interface object that gets data from a SFBSource Interface object.
static
SFBSourceUtilSmp
NewInstance( SFCErrorPtr exception = null )
Create a new SourceUtil instance.
static
SFBSourceUtilSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
Create a new SourceUtil instance.
SFCError PeekFromMemory( VoidConstPtr buf , SInt32 size , PFNNOTIFY notify , VoidPtr data , SFBPeekSmpPtr handle )
Make a new SFBPeek Interface object that gets data from a memory block.
SFCError PeekFromMemory( SFXBufferConstRef buf , PFNNOTIFY notify , VoidPtr data , SFBPeekSmpPtr handle )
Make a new SFBPeek Interface object that gets data from a memory block.
SFBPeekSmp PeekFromMemory( VoidConstPtr buf , SInt32 size , PFNNOTIFY notify , VoidPtr data )
Make a new SFBPeek Interface object that gets data from a memory block.
SFBPeekSmp PeekFromMemory( SFXBufferConstRef buf , PFNNOTIFY notify , VoidPtr data )
Make a new SFBPeek Interface object that gets data from a memory block.
SFCError PeekFromSource( SFBSourceSmpConstRef src , SInt32 size , SFBPeekSmpPtr handle )
Make a new SFBPeek Interface object that gets data from a SFBSource Interface object.
SFBPeekSmp PeekFromSource( SFBSourceSmpConstRef src , SInt32 size )
Make a new SFBPeek Interface object that gets data from a SFBSource Interface object.
SFCError SourceFromAStream( SFBAStreamSmpConstRef src , SFBSourceSmpPtr handle )
Make a new SFBSource Interface object that gets data from a SFBAStream Interface object.
SFBSourceSmp SourceFromAStream( SFBAStreamSmpConstRef src )
Make a new SFBSource Interface object that gets data from a SFBAStream Interface object.
SFCError SourceFromMemory( VoidConstPtr src , SInt32 size , PFNNOTIFY notify , VoidPtr data , SFBSourceSmpPtr hadle )
Make a new SFBSource Interface object that gets data from a memory block.
SFCError SourceFromMemory( SFXBufferConstRef src , PFNNOTIFY notify , VoidPtr data , SFBSourceSmpPtr hadle )
Make a new SFBSource Interface object that gets data from a memory block.
SFBSourceSmp SourceFromMemory( VoidConstPtr src , SInt32 size , PFNNOTIFY notify , VoidPtr data )
Make a new SFBSource Interface object that gets data from a memory block.
SFBSourceSmp SourceFromMemory( SFXBufferConstRef src , PFNNOTIFY notify , VoidPtr data )
Make a new SFBSource Interface object that gets data from a memory block.
SFCError SourceFromSocket( SFBSocketSmpConstRef src , SFBSourceSmpPtr handle )
Make a new SFBSource Interface object that gets data from an SFBSocket Interface object.
SFBSourceSmp SourceFromSocket( SFBSocketSmpConstRef src )
Make a new SFBSource Interface object that gets data from an SFBSocket Interface object.
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.

SFBSourceUtil::AStreamFromSource
Make a new SFBAStream Interface object that gets data from a SFBSource Interface object.
[ public ]
SFCError AStreamFromSource(
    SFBSourceSmpConstRef src   // data source to read from
    SFBAStreamSmpPtr handle    // pointer to the interface pointer to be filled with resulting SFBAStream Interface object
);
[ public ]
SFBAStreamSmp AStreamFromSource(
    SFBSourceSmpConstRef src   // data source to read from
);

Reference

BREW API ISOURCEUTIL_AStreamFromSource | SFBSourceUtil::SourceFromAStream


SFBSourceUtil::GetLineFromSource
Make a new SFBGetLine Interface object that gets data from a SFBSource Interface object.
[ public ]
SFCError GetLineFromSource(
    SFBSourceSmpConstRef src   // data source
    SInt32 size                // amount of memory to try to allocate for buffering, should have some relevance to data being read
    SFBGetLineSmpPtr handle    // pointer to the interface pointer to be filled with resulting SFBGetLine Interface object
);
[ public ]
SFBGetLineSmp GetLineFromSource(
    SFBSourceSmpConstRef src   // data source
    SInt32 size                // amount of memory to try to allocate for buffering, should have some relevance to data being read
);

Reference

BREW API ISOURCEUTIL_GetLineFromSource | SFBSourceUtil::PeekFromMemory


SFBSourceUtil::NewInstance
Create a new SourceUtil instance.
[ public, static ]
SFBSourceUtilSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);
[ public, static ]
SFBSourceUtilSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBSourceUtil::PeekFromMemory
Make a new SFBPeek Interface object that gets data from a memory block.
[ public ]
SFCError PeekFromMemory(
    VoidConstPtr buf       // buffer that is the data
    SInt32 size            // number of bytes in pBuf
    PFNNOTIFY notify       // where to call when finished with the memory, may be null
    VoidPtr data           // parameter to pass to notify
    SFBPeekSmpPtr handle   // pointer to the interface pointer to be filled with resulting SFBPeek Interface object
);
[ public ]
SFCError PeekFromMemory(
    SFXBufferConstRef buf   // buffer that is the data
    PFNNOTIFY notify        // where to call when finished with the memory, may be null
    VoidPtr data            // parameter to pass to notify
    SFBPeekSmpPtr handle    // pointer to the interface pointer to be filled with resulting SFBPeek Interface object
);
[ public ]
SFBPeekSmp PeekFromMemory(
    VoidConstPtr buf   // buffer that is the data
    SInt32 size        // number of bytes in pBuf
    PFNNOTIFY notify   // where to call when finished with the memory, may be null
    VoidPtr data       // parameter to pass to notify
);
[ public ]
SFBPeekSmp PeekFromMemory(
    SFXBufferConstRef buf   // buffer that is the data
    PFNNOTIFY notify        // where to call when finished with the memory, may be null
    VoidPtr data            // parameter to pass to notify
);

Reference

BREW API ISOURCEUTIL_PeekFromMemory | SFBSourceUtil::SourceFromAStream


SFBSourceUtil::PeekFromSource
Make a new SFBPeek Interface object that gets data from a SFBSource Interface object.
[ public ]
SFCError PeekFromSource(
    SFBSourceSmpConstRef src   // SFBSource Interface object that is source of data
    SInt32 size                // amount of memory to try to allocate for buffering, should have some relevance to data being read
    SFBPeekSmpPtr handle       // pointer to the interface pointer to be filled with resulting SFBPeek Interface object
);
[ public ]
SFBPeekSmp PeekFromSource(
    SFBSourceSmpConstRef src   // SFBSource Interface object that is source of data
    SInt32 size                // amount of memory to try to allocate for buffering, should have some relevance to data being read
);

Reference

BREW API ISOURCEUTIL_PeekFromSource


SFBSourceUtil::SourceFromAStream
Make a new SFBSource Interface object that gets data from a SFBAStream Interface object.
[ public ]
SFCError SourceFromAStream(
    SFBAStreamSmpConstRef src   // SFBAStream Interface object to read from
    SFBSourceSmpPtr handle      // pointer to the interface pointer to be filled with resulting SFBSource Interface object
);
[ public ]
SFBSourceSmp SourceFromAStream(
    SFBAStreamSmpConstRef src   // SFBAStream Interface object to read from
);

Reference

BREW API ISOURCEUTIL_SourceFromAStream | SFBSourceUtil::AStreamFromSource


SFBSourceUtil::SourceFromMemory
Make a new SFBSource Interface object that gets data from a memory block.
[ public ]
SFCError SourceFromMemory(
    VoidConstPtr src        // data buffer
    SInt32 size             // number of bytes in src
    PFNNOTIFY notify        // where to call when finished with the memory, may be null
    VoidPtr data            // parameter to pass to notify
    SFBSourceSmpPtr hadle   // pointer to the interface pointer to be filled with resulting SFBSource Interface object
);
[ public ]
SFCError SourceFromMemory(
    SFXBufferConstRef src   // data buffer
    PFNNOTIFY notify        // where to call when finished with the memory, may be null
    VoidPtr data            // parameter to pass to notify
    SFBSourceSmpPtr hadle   // pointer to the interface pointer to be filled with resulting SFBSource Interface object
);
[ public ]
SFBSourceSmp SourceFromMemory(
    VoidConstPtr src   // data buffer
    SInt32 size        // number of bytes in src
    PFNNOTIFY notify   // where to call when finished with the memory, may be null
    VoidPtr data       // parameter to pass to notify
);
[ public ]
SFBSourceSmp SourceFromMemory(
    SFXBufferConstRef src   // data buffer
    PFNNOTIFY notify        // where to call when finished with the memory, may be null
    VoidPtr data            // parameter to pass to notify
);

Reference

BREW API ISOURCEUTIL_SourceFromMemory | PFNNOTIFY | FREE


SFBSourceUtil::SourceFromSocket
Make a new SFBSource Interface object that gets data from an SFBSocket Interface object.
[ public ]
SFCError SourceFromSocket(
    SFBSocketSmpConstRef src   // SFBSocket Interface object to read from
    SFBSourceSmpPtr handle     // pointer to the interface pointer to be filled with resulting SFBSource Interface object
);
[ public ]
SFBSourceSmp SourceFromSocket(
    SFBSocketSmpConstRef src   // SFBSocket Interface object to read from
);

Reference

BREW API ISOURCEUTIL_SourceFromSocket