SFBVersion

Wrapper Class for the IVersion interface.

#include <SFBVersion.h.hpp>

class SFBVersion : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBVersion)

Inheritance diagram

Version

Introduced BREW Client 3.1.5 SP01 or 4.0.2

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

Reference

BREW API IVersion

Member

Public Functions
`SFCError`	GetInfoString( `SInt32` infoId , `ACharPtr` buffer , `SInt32` length , `SInt32Ptr` lenreq ) Retrieve information like the product name and the vendor name from the installed component.
`SFCError`	GetInfoString( `SInt32` infoId , `SFXAnsiStringPtr` string ) Retrieve information like the product name and the vendor name from the installed component.
`SFCError`	GetProductName( `ACharPtr` productName , `SInt32` length , `SInt32Ptr` lenreq ) Retrieve the product name of the installed component.
`SFCError`	GetProductName( `SFXAnsiStringPtr` name ) Retrieve the product name of the installed component.
`SFCError`	GetVendorName( `ACharPtr` vendorName , `SInt32` length , `SInt32Ptr` lenreq ) Retrieve the vendor name of the installed component.
`SFCError`	GetVendorName( `SFXAnsiStringPtr` name ) Retrieve the vendor name of the installed component.
`SFCError`	GetVersion( `AEEVersionDesc *` versionDesc , `SInt32` size ) Retrieve the version information of the installed component.
static `SFBVersionSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBVersion instance.
static `SFBVersionSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBVersion 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.

SFBVersion::GetInfoString

Retrieve information like the product name and the vendor name from the installed component.

[ public ]
SFCError GetInfoString(
    SInt32 infoId      // identifies info string to be retrieved
    ACharPtr buffer    // on return, this will contain requested info string. The string will be null terminated. 
    SInt32 length      // the total size (in bytes) of the buffer
    SInt32Ptr lenreq   // on return, this will contain total size (in bytes) of the buffer required to hold requested info string including null termination character.
);

[ public ]
SFCError GetInfoString(
    SInt32 infoId             // identifies info string to be retrieved
    SFXAnsiStringPtr string   // requested info string
);

Reference

BREW API IVersion_GetInfoString

SFBVersion::GetProductName

Retrieve the product name of the installed component.

[ public ]
SFCError GetProductName(
    ACharPtr productName   on return, this will contain product name. The string will be null terminated
    SInt32 length          // the total size (in bytes) of the productName buffer.
    SInt32Ptr lenreq       // on return, this will contain total size (in bytes) of the buffer required to hold product name including the null termination character
);

[ public ]
SFCError GetProductName(
    SFXAnsiStringPtr name   // poduct name
);

Reference

BREW API IVersion_GetProductName

SFBVersion::GetVendorName

Retrieve the vendor name of the installed component.

SFCError GetVendorName(
    ACharPtr vendorName   on return, this will contain vendor name. The string will be null terminated
    SInt32 length         // the total size (in bytes) of the vendorName buffer.
    SInt32Ptr lenreq      // on return, this will contain total size (in bytes) of the buffer required to hold vendor name including the null termination character
);

[ public ]
SFCError GetVendorName(
    SFXAnsiStringPtr name   // poduct name
);

Reference

BREW API IVersion_GetVendorName

SFBVersion::GetVersion

Retrieve the version information of the installed component.

[ public ]
SFCError GetVersion(
    AEEVersionDesc * versionDesc   // on return, pvd contains detail version information of the component
    SInt32 size                    // size of AEEVersionDesc structure
);

Reference

BREW API IVersion_GetVersion

SFBVersion::NewInstance

Create a new SFBVersion instance.

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

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