company logo

DictionaryHandle :: CopyType - Copy type definition

The function copies a type definition from one dictionary to another.

Return value:  Success ( logical  )

Implementation details

  1. - internal feature (not documented)
    logical DictionaryHandle  :: CopyType ( DictionaryHandle &srce_dicthandle, NString &strnames, NString &newnames, NString &topname=NString::Null(), PIREPL db_replace=REPL_none, logical retainSID=NO, logical transaction=NO, logical retain_schemav=NO )
    • srce_dicthandle - Reference to source dictionary handle
    • strnames - Type name
    • newnames - New name

      String that defines the new name/key for a object that is about to be renamed or copied

    • topname - Name of top-type

      This field should contain the name of the type to be copied on top (when calling the function from an application). When processing recursive copy operations the name is used to avoid recursion while copying.

      Default: NString::Null()
    • db_replace - Replace option

      Replace options can be passed in order to control the behavior of copy functions.

      Default: REPL_none
    • retainSID - Retain internal type numbers

      If this option is set to true the function tries to reuse the internal type number defined for the type in the source dictionary. If this is not possible the type gets a new number in the target dictionary. This option is used, only, when copying a complete dictionary.

      Default: NO
    • transaction - Transaction option

      When passing true the function creates a transaction while operating.

      Default: NO
    • retain_schemav - Retain schema version

      This option indicates, that the schema version from the source type should be copied (true). When the option is false, the schema version for the target type definition is set to 0.

      Default: NO
  2. to list
  3. - internal feature (not documented)
    logical DictionaryHandle  :: CopyType ( DictionaryHandle &srce_dicthandle, NString &strnames, int32 nsid, NString &newnames, NString &topname=NString::Null(), PIREPL db_replace=REPL_none, logical retainSID=NO, logical transaction=NO, logical retain_schemav=NO )
    • srce_dicthandle - Reference to source dictionary handle
    • strnames - Type name
    • nsid - - internal feature (not documented)
    • newnames - New name

      String that defines the new name/key for a object that is about to be renamed or copied

    • topname - Name of top-type

      This field should contain the name of the type to be copied on top (when calling the function from an application). When processing recursive copy operations the name is used to avoid recursion while copying.

      Default: NString::Null()
    • db_replace - Replace option

      Replace options can be passed in order to control the behavior of copy functions.

      Default: REPL_none
    • retainSID - Retain internal type numbers

      If this option is set to true the function tries to reuse the internal type number defined for the type in the source dictionary. If this is not possible the type gets a new number in the target dictionary. This option is used, only, when copying a complete dictionary.

      Default: NO
    • transaction - Transaction option

      When passing true the function creates a transaction while operating.

      Default: NO
    • retain_schemav - Retain schema version

      This option indicates, that the schema version from the source type should be copied (true). When the option is false, the schema version for the target type definition is set to 0.

      Default: NO
  4. to list