System CATBaseUnknown
Usage: you can derive this class.
public class CATBaseUnknown
Base class for creating interfaces and for implementing interfaces.
Role: CATBaseUnknown supplies the infrastructure and the basic mechanisms
to create interface abstract classes and to manage interface pointers.
It is also the base class for classes which implements interfaces
and for their extension classes because it supplies the code for
the interface methods ,
and
.
Constructor and Destructor Index
- o
CATBaseUnknown()
- Constructs a empty instance.
- o
CATBaseUnknown(CATBaseUnknown&)
- Copy Constructor.
- o
~CATBaseUnknown()
-
Method Index
- o
AddRef()
- Increments the reference count for the given interface.
- o
ClassName()
- Returns the class name for which the given object is an instance.
- o
IsAKindOf(char*)
- Determines whether the given object's class derives from a given class.
- o
IsEqual(CATBaseUnknown*)
- Compares implementations pointed by interfaces.
- o
QueryInterface(IID&,void**)
- Retrieves a pointer to a given interface.
- o
Release()
- Decrements the reference count for the given interface.
Constructor and Destructor
o CATBaseUnknown
-
Constructs a empty instance.
o CATBaseUnknown
| public CATBaseUnknown( | const | iObj) |
-
Copy Constructor.
- Parameters:
-
- iObj
- The CATBaseUnknown instance to copy
o ~CATBaseUnknown
| public virtual ~CATBaseUnknown( | ) |
-
Methods
o AddRef
-
Increments the reference count for the given interface.
- Returns:
- The reference count value.
This information is meant to be used for diagnostic/testing purposes only, because, in certain situations, the value may be unstable.
o ClassName
| public static ClassName( | ) |
-
Returns the class name for which the given object is an instance.
o IsAKindOf
| public virtual IsAKindOf( | const | iName) |
-
Determines whether the given object's class derives from a given class.
- Parameters:
-
- iName
- The class name from which the given object's class is supposed to derive.
- Returns:
- 0 if the given object's class doesn't derive from iName and a non null value otherwise.
- Returns:
-
Legal values:
- 0
- Current onject does not derive from iName.
- 1
- Otherwise.
o IsEqual
| public virtual IsEqual( | const | iobject) |
-
Compares implementations pointed by interfaces.
- Parameters:
-
- iobject
- The second object to be compared to.
- Returns:
- 1 if the implementations are identical.
o QueryInterface
| public virtual QueryInterface( | const | iIID, |
| | oPPV) |
-
Retrieves a pointer to a given interface.
- Parameters:
-
- iIID
- The interface identifier for which a pointer is requested.
- oPPV
- The address where the returned pointer to the interface is located.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The query succeeds.
- E_NOINTERFACE
- The interface does not exist.
- E_FAIL
- The object is not valid.
- E_OUTOFMEMORY
- One memory allocation fails
- E_UNEXPECTED
- The query fails for any other reason
o Release
-
Decrements the reference count for the given interface.
- Returns:
- The reference count value.
This information is meant to be used for diagnostic/testing purposes only, because, in certain situations, the value may be unstable.
This object is included in the file: CATBaseUnknown.h
If needed, your Imakefile.mk should include the module: JS0GROUP
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.