SFBParameters

Wrapper Class for the IParameters interface.

#include <SFBParameters.h.hpp>

class SFBParameters : public SFBParametersRO;

SFMTYPEDEFWRAPPER(SFBParameters)

Inheritance diagram

Version

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

Reference

BREW API IParameters

Member

Public Functions
static `SFBParametersSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBParameters instance.
static `SFBParametersSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBParameters instance.
`SFCError`	SetParam( `SInt32` id , `VoidConstPtr` data , `UInt32` length ) This method sets a parameter value.
`SFCError`	SetParam( `SInt32` id , `SFXBufferConstRef` data ) This method sets a parameter value.
`SFCError`	SetParam( `SInt32` id , `SFXAnsiStringConstRef` data ) This method sets a parameter value.

SFBParameters::NewInstance

Create a new SFBParameters instance.

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

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

SFBParameters::SetParam

This method sets a parameter value.

[ public ]
SFCError SetParam(
    SInt32 id           // the parameter to set 
    VoidConstPtr data   // points to data / buffer to set
    UInt32 length       // size of the data pointed to by pParam 
);

[ public ]
SFCError SetParam(
    SInt32 id                // the parameter to set 
    SFXBufferConstRef data   // points to data / buffer to set
);

[ public ]
SFCError SetParam(
    SInt32 id                    // the parameter to set 
    SFXAnsiStringConstRef data   // points to data / buffer to set
);

Return value

AEE_SUCCESS if the data is copied
AEE_ENOSUCH if the parameter ID is not known
AEE_EREADONLY can get parameter, but not set it
AEE_ENOMEMORY can't allocate heap memory to store param

Other return values per implementation or parameter type.

Description

The standard behavior is to copy the data pointed to by pParam. The number of bytes given in uParamLen will be copied.

The caller can assume the data has been copied and doesn't have to manage the lifetime of the data any further.

Reference

BREW API IParameters_SetParam