Miscellaneous Static Functions
Collaboration diagram for Miscellaneous Static Functions:
Functions |
|
RDM_RETCODE | rdm_rdmGetVersion (const RDM_TCHAR_T *fmt, RDM_TCHAR_T *buf, size_t bytesIn) |
Return RDM Db Engine version information. More... | |
Detailed Description
Miscelaneous functions API. The functions here are located in \ref lib_rdm. Linker option:\ <pre><code> -l<tt><a href="lib_rdm.html">rdmrdm</a></tt></code></pre>
Function Documentation
rdm_rdmGetVersion()
RDM_RETCODE rdm_rdmGetVersion | ( | const RDM_TCHAR_T * | fmt, |
RDM_TCHAR_T * | buf, | ||
size_t | bytesIn | ||
) |
#include <rdmrdmapi.h>
Return RDM Db Engine version information.
This function fills a buffer with a string describing the version of the RDM library according to a format string. The format string consists of plaintext (copied to the string buffer) and format specifiers introduced by a percent ("%") character. See list below.
If a NULL is passed in for fmt then the default format string will be used. The default format string is the full version string "%V". This corresponds to "%n %v Build %b"
rdm_rdmGetVersion() Type Field Characters
- n Product Name
- v Version number
- b Build number
- V Full version string
- c Copyright date
- w Owner name
- r Rights text
- C Full Copyright string
- %% Literal percent character
- Return values
-
sOKAY Normal, successful return.
- Locking Requirements
- None
- Parameters
-
[in] fmt [in] A string that specifies how the version information is to be formatted. [out] buf [out] A string buffer to receive the formatted version string. [in] bytesIn [in] The length of buf in bytes