All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspID
System.IUnknown
|
+---CATIPspID
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspID
Interface to generate and set IDs for the Plant Ship Objects.
Role: This is the interface for Plant Ship object ID generation.
Method Index
- o
GenAndPutID(CATUnicodeString&,int)
- ID is generated with the sequence number and is stored on the object.
- o
GenAndPutIDNoGenSeqNum(CATUnicodeString&)
- ID is generated without sequence number and is stored on the object.
- o
GenIDNoGenSeqNum(CATUnicodeString&)
- ID is generated without sequence number.
- o
GetID(CATUnicodeString&)
- Get ID of the object.
- o
GetLocalID(CATUnicodeString&)
- Get LocalID of the object.
- o
IsIDGenerated(CATBoolean&)
- Is Object ID generated by the ID schema.
- o
SetID(CATUnicodeString&)
- Set ID of the object with the user defined string.
Methods
o GenAndPutID
-
ID is generated with the sequence number and is stored on the object.
- Parameters:
-
- oGeneratedID
- ID associated with the Plant Ship Object
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GenAndPutIDNoGenSeqNum
-
ID is generated without sequence number and is stored on the object.
- Parameters:
-
- oGeneratedID
- ID associated with the Plant Ship Object
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GenIDNoGenSeqNum
-
ID is generated without sequence number.
- Parameters:
-
- oGeneratedID
- ID associated with the Plant Ship Object
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetID
-
Get ID of the object.
- Parameters:
-
- oID
- ID associated with the Plant Ship Object. Null string if no ID
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetLocalID
-
Get LocalID of the object.
- Parameters:
-
- oID
- ID associated with the Plant Ship Object. Null string if no ID is generated
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o IsIDGenerated
-
Is Object ID generated by the ID schema.
- Parameters:
-
- fResult
- TRUE if generated by the ID Schema
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetID
-
Set ID of the object with the user defined string.
- Parameters:
-
- iID
- input ID
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspID.h