SFBvParm

Wrapper Class for the IvParm interface.

#include <SFBvParm.h.hpp>

class SFBvParm : public SFBvObject;

SFMTYPEDEFWRAPPER(SFBvParm)

Inheritance diagram

Version

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

Reference

BREW API IvParm

Member

Public Functions
`SFCError`	AddValue( `UInt32` value , `WCharPtr` buffer ) Add a value to SFBvParm object.
`SFCError`	GetId( `AEEVParameter *` paramId ) Get the Parameter Identifier.
`SFCError`	GetName( `ACharPtr` name , `SInt32` length , `SInt32Ptr` lenreq ) Get the parameter name.
`SFCError`	GetName( `SFXAnsiStringPtr` name ) Get the parameter name.
`SFCError`	GetNumberOfValues( `SInt32Ptr` num ) Get the number of values associated with a parameter.
`SFCError`	InitParm( `AEEVParameter` paramId , `ACharPtr` name , `UInt32` value , `WCharPtr` buffer ) Initialize a SFBvParm object, with specified ID or an extended name
static `SFBvParmSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBvParm instance.
static `SFBvParmSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBvParm instance.
`SFCError`	ParseValue( `Bool` parseData , `SInt32` index , `UInt32Ptr` value , `VoidPtr` buffer , `SInt32` size , `SInt32Ptr` sizereq ) Get the value associated with a parameter either raw buffer or parsed value.
`SFCError`	ParseValue( `Bool` parseData , `SInt32` index , `UInt32Ptr` value , `SFXBufferPtr` buffer ) Get the value associated with a parameter either raw buffer or parsed value.
`SFCError`	GetObjectType( `AEECLSID *` type ) (inherits from SFBvObject) Return the AEECLSID of the current object type.
`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.

SFBvParm::AddValue

Add a value to SFBvParm object.

[ public ]
SFCError AddValue(
    UInt32 value      // the parameter value
    WCharPtr buffer   // params which are not listed or which are extended (required for vCal version 2.0)
);

Reference

BREW API IvParm_AddValue

SFBvParm::GetId

Get the Parameter Identifier.

[ public ]
SFCError GetId(
    AEEVParameter * paramId   // upon return would contain the parameter id
);

Reference

BREW API IvParm_GetId

SFBvParm::GetName

Get the parameter name.

[ public ]
SFCError GetName(
    ACharPtr name      // to be filled with the name of the parameter
    SInt32 length      // size of the name buffer 
    SInt32Ptr lenreq   // indicates the size of the buffer
);

[ public ]
SFCError GetName(
    SFXAnsiStringPtr name   // the name of the parameter
);

Reference

BREW API IvParm_GetName

SFBvParm::GetNumberOfValues

Get the number of values associated with a parameter.

[ public ]
SFCError GetNumberOfValues(
    SInt32Ptr num   // pointer to number of values returned
);

Reference

BREW API IvParm_GetNumberOfValues

SFBvParm::InitParm

Initialize a SFBvParm object, with specified ID or an extended name

[ public ]
SFCError InitParm(
    AEEVParameter paramId   // the parameter ID
    ACharPtr name           // name of the extended parameter
    UInt32 value            // the parameter value, if not valid should be set 0
    WCharPtr buffer         // buffer for param values which are not listed or which are extended
);

Reference

BREW API IvParm_InitParm

SFBvParm::NewInstance

Create a new SFBvParm instance.

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

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

SFBvParm::ParseValue

Get the value associated with a parameter either raw buffer or parsed value.

[ public ]
SFCError ParseValue(
    Bool parseData      // indicate whether the user wants a raw value of the buffer or a parsed data
    SInt32 index        // the index of the value that has to be retrieved, the index is zero based
    UInt32Ptr value     // pointer to the value where it will be stored. This is one of the enums
    VoidPtr buffer      // pointer to the param value if param is from unhandled list or param value is EXTENDED
    SInt32 size         // size of buffer
    SInt32Ptr sizereq   // required buffer size
);

[ public ]
SFCError ParseValue(
    Bool parseData        // Indicates whether the user wants a raw value of the buffer or a parsed data
    SInt32 index          // the index of the value that has to be retrieved, the index is zero based
    UInt32Ptr value       // pointer to the value where it will be stored. This is one of the enums
    SFXBufferPtr buffer   // the param value if param is from unhandled list or param value is EXTENDED
);

Reference

BREW API IvParm_ParseValue