SFBTopVisibleCtl

Wrapper class fot the ITopVisibleCtl interface.

#include <SFBTopVisibleCtl.h.hpp>

class SFBTopVisibleCtl : public SFBResourceCtl;

SFMTYPEDEFWRAPPER(SFBTopVisibleCtl)

Inheritance diagram

Version

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

Reference

BREW API ITopVisibleCtl

Member

Public Functions
`SFCError`	GetArgs( `ACharPtr` args , `SInt32Ptr` size ) Get the Args property of SFBTopVisibleCtl.
`SFCError`	GetArgs( `SFXAnsiStringPtr` args ) Get the Args property of SFBTopVisibleCtl.
static `SFBTopVisibleCtlSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBTopVisibleCtl instance.
static `SFBTopVisibleCtlSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBTopVisibleCtl instance.
`SFCError`	SetArgs( `ACharConstPtr` args , `SInt32Ptr` size ) set Args property in SFBTopVisibleCtl so it later can be retrieved by OEMResArbiter.
`SFCError`	SetArgs( `SFXAnsiStringConstRef` args ) set Args property in SFBTopVisibleCtl so it later can be retrieved by OEMResArbiter.
`SFCError`	Acquire( `UInt32` reason , `UInt32Ptr` status ) (inherits from SFBResourceCtl) Acquire control of the resource.
`UInt32`	Acquire( `UInt32` reason ) (inherits from SFBResourceCtl) Acquire control of the resource.
`SFCError`	CanAcquire( `UInt32` reason , `UInt32Ptr` status ) (inherits from SFBResourceCtl) Query whether the caller may acquire control of the resource.
`UInt32`	CanAcquire( `UInt32` reason ) (inherits from SFBResourceCtl) Query whether the caller may acquire control of the resource.
`SFCError`	Free( `UInt32Ptr` status ) (inherits from SFBResourceCtl) Release the resource.
`UInt32`	Free( `Void` ) (inherits from SFBResourceCtl) Release the resource.
`UInt32`	GetStatus( `UInt32Ptr` status ) (inherits from SFBResourceCtl) Return the current ownership status of the resource.
`UInt32`	GetStatus( `Void` ) (inherits from SFBResourceCtl) Return the current ownership status of the resource.
`SFCError`	OnStatusChangeNotify( `UInt32` statusMask , `SFXCallbackPtr` callback ) (inherits from SFBResourceCtl) Allow the caller to receive a callback when the status of the resource changes.
`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.
`SFCError`	SetRelinquishCtl( `AEECLSID*` clsidList , `SInt32` count ) (inherits from SFBResourceCtl) Allow the caller to define a list of class Ids, group ids and/or RESCTL_REASONs for releasing the resource to another requestor.
`SFCError`	SetRelinquishCtlAll( `Void` ) (inherits from SFBResourceCtl) Set the relinquish control list to allow any requestor to acquire the resource.
`SFCError`	SetRelinquishCtlNone( `Void` ) (inherits from SFBResourceCtl) Set the relinquish control list to prohibit any requestor from acquiring the resource.

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.

SFBTopVisibleCtl::GetArgs

Get the Args property of SFBTopVisibleCtl.

[ public ]
SFCError GetArgs(
    ACharPtr args    // pointer to a buffer into which to copy arguments
    SInt32Ptr size   // max number of characters to place in the above buffer
);

[ public ]
SFCError GetArgs(
    SFXAnsiStringPtr args   // pointer to a buffer into which to copy arguments
);

Return value

If succeeds: SFERR_NO_ERROR
args is null: SFERR_INVALID_PARAM
If insufficient memory: SFERR_NO_MEMORY
If failed: SFERR_FAILED

Reference

BREW API ITOPVISIBLECTL_GetArgs | SFBTopVisibleCtl::SetArgs

SFBTopVisibleCtl::NewInstance

Create a new SFBTopVisibleCtl instance.

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

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

SFBTopVisibleCtl::SetArgs

set Args property in SFBTopVisibleCtl so it later can be retrieved by OEMResArbiter.

[ public ]
SFCError SetArgs(
    ACharConstPtr args   // null terminated string containing arguments
    SInt32Ptr size       // size of args
);

[ public ]
SFCError SetArgs(
    SFXAnsiStringConstRef args   // string
);

Return value

If succeeds: SFERR_NO_ERROR
If insufficient memory: SFERR_NO_MEMORY

Reference

BREW API ITOPVISIBLECTL_SetArgs | SFBTopVisibleCtl::GetArgs