All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDACreate

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---VPMDesktopObjects.CATIVPMVDAModify
              |
              +---CATIAVPMVDACreate
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIAVPMVDACreate

Interface to create a new Business Object.
Role : The interface is designed for creating a new Business Object from its type and some basic identifiers.


Method Index


o get_BObject(ENOVIABusinessObject*&)
Retrieves the new created Business Object.
o get_ObjectData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
o get_ObjectData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Retrieves the identifiers of the Business Object to create.
o get_Version(CATUnicodeString&)
Retrieves the version of the new Business Object to create.
o put_ObjectData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
o put_ObjectData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Sets the parameters needed to create a new Business Object.
o put_Version(CATUnicodeString&)
Sets the version of the Business Object to create.

Methods


o get_BObject
public virtual HRESULT get_BObject(ENOVIABusinessObject*& ioObject)=0
Retrieves the new created Business Object. This method should be used after the execution of the command.
Parameters:
ioObject
The new created Business Object.
Returns:
S_OK in case of success.
o get_ObjectData
public virtual HRESULT get_ObjectData(CATUnicodeString& iType,
CATUnicodeString& iId,
CATUnicodeString& iName,
CATUnicodeString& iDesc)=0
Deprecated:
V5R15 Retrieves the identifiers of the Business Object to create. It is designed for the user exits for the customer, and should not be used in another context.
Parameters:
iType
The type of the object to create.
iId
The identifier of the object.
iName
The name of the object.
iDesc
The description of the object.
Returns:
S_OK in all cases.
o get_ObjectData
public virtual HRESULT get_ObjectData(CATUnicodeString& iType,
CATUnicodeString& iId,
CATUnicodeString& iName,
CATUnicodeString& iDesc,
CATUnicodeString& iEnvironment)=0
Retrieves the identifiers of the Business Object to create. It is designed for the user exits for the customer, and should not be used in another context.
Parameters:
iType
The type of the object to create.
iId
The identifier of the object.
iName
The name of the object.
iDesc
The description of the object.
iEnvironment
The environment in which the object is created.
Returns:
S_OK in all cases.
o get_Version
public virtual HRESULT get_Version(CATUnicodeString& ioVersion)=0
Retrieves the version of the new Business Object to create. It is designed for the user exits for the customer, and should not be used in another context.
Parameters:
ioVersion
The version of the object.
Returns:
S_OK in all cases.
o put_ObjectData
public virtual HRESULT put_ObjectData( const CATUnicodeString& iType,
const CATUnicodeString& iId,
const CATUnicodeString& iName,
const CATUnicodeString& iDesc)=0
Deprecated:
V5R15 Sets the parameters needed to create a new Business Object.
Parameters:
iType
The type of the Business Object to create.
iId
The identifier of the object. It must be filled and unique.
iName
The name of the object (may be blank).
iDesc
A description of the object (may be blank).
Returns:
S_OK in case of success, E_FAIL if the type is unknown or if a problem occurred during creation.
o put_ObjectData
public virtual HRESULT put_ObjectData( const CATUnicodeString& iType,
const CATUnicodeString& iId,
const CATUnicodeString& iName,
const CATUnicodeString& iDesc,
const CATUnicodeString& iEnvironment)=0
Sets the parameters needed to create a new Business Object.
Parameters:
iType
The type of the Business Object to create.
iId
The identifier of the object. It must be filled and unique.
iName
The name of the object (may be blank).
iDesc
A description of the object (may be blank).
iEnvironment
The environment in which the object will be created.
Returns:
S_OK in case of success, E_FAIL if the type is unknown or if a problem occurred during creation.
o put_Version
public virtual HRESULT put_Version( const CATUnicodeString& iVersion)=0
Sets the version of the Business Object to create. This applies to versionnable objects only. If this parameter is not set, a default version is given.
Parameters:
iVersion
The version of the new created object.
Returns:
S_OK in case of success, E_FAIL in case of error.

This object is included in the file: CATIAVPMVDACreate.h
If needed, your Imakefile.mk should include the module: VDO0Commands

Copyright © 2003, Dassault Systèmes. All rights reserved.