company logo

PropertyHandle :: ProvideExtension - Create property extension

The function allows creating a property extension with the name passed in sExtension, which is based on an extension property, i.e. a property that has been defined as extension property in the database or dictionary. The function has to be called for managed property extensions, only. The function returns true,when the instance has been created successfully or when the extension has already been added to the instance's extension list. In order to check, whether the property extension exists or not, Property::extensionExist() might be called.

The function throws an exception, when the property does not refer to an extendable data type.

The function throws an exception when being called for an ordinary property (i.e. a property, which is not an extension property.

... fragment ( Property &person ) {

  Property    ext_remarks(person,ext_remarks); // extension property

  if ( person.tryGet("P1") )

    if ( !extensionExist("ext_remarks") )

      ext_remarks.provideExtension("ext_remarks");

}

Return value:  Success ( logical  )

Implementation overview

Implementation details

  1. - internal feature (not documented)
    logical PropertyHandle  :: ProvideExtension (  )
  2. to list
  3. - internal feature (not documented)
    logical PropertyHandle  :: ProvideExtension ( NString &propnames )
    • propnames - Property name

      In contrast to a property path, the property name is just the name of the current property without the hierarchy to the property path. The property name is passed as 0-terminated string

  4. to list