SophiaFramework UNIVERSE 5.3 |
#include <SFBOBEXHeader.h.hpp>
class SFBOBEXHeader : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBOBEXHeader)
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
X | X | O | O |
Public Functions | |
---|---|
SFCError |
AddByte(
AEEOBEXHeaderID headerId
, UInt08 data
) Add to the list, an OBEX header which is a single byte value.
|
SFCError |
AddByteSeq(
AEEOBEXHeaderID headerId
, UInt08ConstPtr buffer
, SInt32 length
) Add to the list, an OBEX header which is a byte sequence.
|
SFCError |
AddByteSeq(
AEEOBEXHeaderID headerId
, SFXBufferConstRef buffer
) Add to the list, an OBEX header which is a byte sequence.
|
SFCError |
AddString(
AEEOBEXHeaderID headerId
, WCharConstPtr seq
, SInt32 length
) Add to the list, an OBEX header which is of type unicode (usc2) string.
|
SFCError |
AddString(
AEEOBEXHeaderID headerId
, SFXWideStringConstRef seq
) Add to the list, an OBEX header which is of type unicode (usc2) string.
|
SFCError |
AddU32(
AEEOBEXHeaderID headerId
, UInt32 data
) Add to the list, an OBEX header which is a four byte value.
|
SFCError |
GetByte(
AEEOBEXHeaderID headerId
, UInt08Ptr data
) Retrieve an OBEX header which is a single byte value.
|
SFCError |
GetByteAtIndex(
SInt32 index
, UInt08Ptr data
) Retrieve an OBEX header which is a single byte value and at a particular index in the list.
|
SFCError |
GetByteSeq(
AEEOBEXHeaderID headerId
, SInt32 offset
, UInt08Ptr buffer
, SInt32 length
, SInt32Ptr lenreq
) Retrieve an OBEX header which is a byte sequence.
|
SFCError |
GetByteSeq(
AEEOBEXHeaderID headerId
, SInt32 offset
, SFXBufferPtr buffer
) Retrieve an OBEX header which is a byte sequence.
|
SFCError |
GetByteSeqAtIndex(
SInt32 index
, SInt32 offset
, UInt08Ptr data
, SInt32 length
) Retrieve an OBEX header at a particular index. The header is of type byte sequence.
|
SFCError |
GetByteSeqAtIndex(
SInt32 index
, SInt32 offset
, SFXBufferPtr buffer
) Retrieve an OBEX header at a particular index. The header is of type byte sequence.
|
SFCError |
GetList(
AEEOBEXHeader * header
, SInt32 offset
, SInt32 length
, SInt32Ptr lenreq
) Get an array of header IDs and their corresponding size.
|
SFCError |
GetString(
AEEOBEXHeaderID headerId
, WCharPtr seq
, SInt32 length
, SInt32Ptr lenreq
) Retrieve an OBEX header which is a unicode (usc2) string.
|
SFCError |
GetString(
AEEOBEXHeaderID headerId
, SFXWideStringPtr seq
) Retrieve an OBEX header which is a unicode (usc2) string.
|
SFCError |
GetStringAtIndex(
SInt32 index
, WCharPtr seq
, SInt32 length
) Retrieve an OBEX header at a particular index. The header is of type unicode (usc2) string.
|
SFCError |
GetU32(
AEEOBEXHeaderID headerId
, UInt32Ptr data
) Retrieve an OBEX header which is a four byte value.
|
SFCError |
GetU32AtIndex(
SInt32 index
, UInt32Ptr data
) Retrieve an OBEX header which is a four byte value and at a particular index in the list.
|
static SFBOBEXHeaderSmp |
NewInstance(
SFCErrorPtr exception = null
) Create a new SFBOBEXHeader instance.
|
static SFBOBEXHeaderSmp |
NewInstance(
AEECLSID id
, SFCErrorPtr exception = null
) Create a new SFBOBEXHeader 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.
|
[ public ] SFCError AddByte( AEEOBEXHeaderID headerId // OBEX header ID UInt08 data // single byte header value );
[ public ] SFCError AddByteSeq( AEEOBEXHeaderID headerId // OBEX header ID UInt08ConstPtr buffer // pointer to the byte sequence SInt32 length // number of bytes in the sequence );
[ public ] SFCError AddByteSeq( AEEOBEXHeaderID headerId // OBEX header ID SFXBufferConstRef buffer // the byte sequence );
[ public ] SFCError AddString( AEEOBEXHeaderID headerId // OBEX header ID WCharConstPtr seq // pointer to the unicode (ucs2) string SInt32 length // number of wide characters allocated for the string including the null terminator. );
[ public ] SFCError AddString( AEEOBEXHeaderID headerId // OBEX header ID SFXWideStringConstRef seq // the unicode (ucs2) string );
[ public ] SFCError AddU32( AEEOBEXHeaderID headerId // OBEX header ID UInt32 data // four byte header value );
[ public ] SFCError GetByte( AEEOBEXHeaderID headerId // header Id of the header begin retrieved UInt08Ptr data // pointer to location where the header is returned );
[ public ] SFCError GetByteAtIndex( SInt32 index // index of the header in the list UInt08Ptr data // pointer to location where the header is returned );
[ public ] SFCError GetByteSeq( AEEOBEXHeaderID headerId // header Id of the header being retrieved SInt32 offset // offset within the byte sequence UInt08Ptr buffer // pointer to buffer to store the header SInt32 length // length of the buffer allocated to retrieve the header SInt32Ptr lenreq // if return value is AEE_EBUFFERTOOSMALL, this location will contain the size of buffer that is required to return the entire header. );
[ public ] SFCError GetByteSeq( AEEOBEXHeaderID headerId // header Id of the header being retrieved SInt32 offset // offset within the byte sequence SFXBufferPtr buffer // buffer to store the header );
[ public ] SFCError GetByteSeqAtIndex( SInt32 index // index of the header in the list SInt32 offset // offset within the sequence from which to retrieve data UInt08Ptr data // pointer to location where the header is returned SInt32 length // length of the buffer );
[ public ] SFCError GetByteSeqAtIndex( SInt32 index // index of the header in the list SInt32 offset // offset within the sequence from which to retrieve data SFXBufferPtr buffer // buffer of the header );
[ public ] SFCError GetList( AEEOBEXHeader * header // pointer to an array of AEEOBEXHeader structures SInt32 offset // offset from the start of the list SInt32 length // number of the elements in header SInt32Ptr lenreq // if return value is AEE_EBUFFERTOOSMALL, this location will contain the number of AEEOBEXHeader elements in header required to return all headers in the list );
[ public ] SFCError GetString( AEEOBEXHeaderID headerId // header Id of the header being retrieved WCharPtr seq // pointer to buffer to store the string SInt32 length // length of the buffer allocated to retrieve the string. The length includes the null terminator SInt32Ptr lenreq // if return value is AEE_EBUFFERTOOSMALL, this location will contain the size of buffer that is required to return the entire string. );
[ public ] SFCError GetString( AEEOBEXHeaderID headerId // header Id of the header being retrieved SFXWideStringPtr seq // to store the string );
[ public ] SFCError GetStringAtIndex( SInt32 index // index of the header in the list. Zero based WCharPtr seq // pointer to location where the header is returned SInt32 length // length of the buffer including the null terminator );
[ public ] SFCError GetU32( AEEOBEXHeaderID headerId // header Id of the header being retrieved UInt32Ptr data // pointer to location where the header is returned );
[ public ] SFCError GetU32AtIndex( SInt32 index // index of the header in the list UInt32Ptr data // pointer to location where the header is returned );
[ public, static ] SFBOBEXHeaderSmp NewInstance( SFCErrorPtr exception = null // Error );
[ public, static ] SFBOBEXHeaderSmp NewInstance( AEECLSID id // Class ID SFCErrorPtr exception = null // Error );
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |