Clobber an existing database on open

saf_setProps_Clobber is a function defined in dbprops.c.

Synopsis:

int saf_setProps_Clobber(SAF_DbProps *properties)

Formal Arguments:

  • properties: The database property list which will be modified by this function (See *Properties*).

Description: When saf_open_database is called with the name of an existing database the default action is to open that database. New data will be appended to it. However, if this property is set, then the existing database will be unlinked before it is opened.

Preconditions:

  • properties must not be null. (high-cost)

Return Value: The constant SAF__SUCCESS is returned when this function is successful. Otherwise this function either returns an error number or throws an exception, depending on the value of the library’s error handling property.

Parallel Notes: This function can be called independently.

Known Bugs: This function sometimes return an error instead of throwing an exception when the library error mode is SAF__ERRMODE_THROW.

See Also: