HDF API Changes Procedure

 

Changing existing Function

No change of functionality, syntax, should be made to an existing Function except in situations such as,

  1. The current definition has errors that when used as is, will interfere or harm the functionality of the overall library. 
  2. The current definition contains mistakes such that it is impossible for it to function as defined.  E.g., the function is defined as an integer type while its actual return value has to be a floating point number.
  3. The added functionality will not change behavior or cause error of applications when used as previous defined.  E.g., adding more possible values of the flags parameter of H5Fopen() is fine but adding a new parameter is not.

 

When existing functions need changes beyond the above provisions, new functions should be created.

 

An existing functions may be retired when it becomes obsolete due to various reasons such as:

  1. When its functionality are mostly supported by other functions and hardly anyone uses it.
  2. When its functionality only work in some obsolete platforms.  E.g., 16 bits DOS platform.

 

---

Rev: AKC 2004/05/13