Difference between revisions of "Library Return Code Values"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
Line 2: Line 2:
  
 
An application program should refer to these values when checking return values from RECITAL/Library functions.  A list of the symbols and their assigned numeric values follows:-
 
An application program should refer to these values when checking return values from RECITAL/Library functions.  A list of the symbols and their assigned numeric values follows:-
 +
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 8: Line 9:
 
|0||SUCCESS||Function executed successfully
 
|0||SUCCESS||Function executed successfully
 
|-
 
|-
|-1||d_ERROR||A function returns –1 if it failed due to fundamental reasons such as wrong input values or the file to be accessed is closed or disk I/O operations failed because of a System limitation such as "disk full".
+
|-1||d_ERROR||A function returns –1 if it failed due to fundamental reasons such as wrong input values or the file to be accessed is closed or disk I/O operations failed because of a System limitation such as "disk full".
 
|-
 
|-
|-2||d_NODBF||File does not have a valid .DBF file structure.
+
|-2||d_NODBF||File does not have a valid .DBF file structure.
 
|-
 
|-
|-3||d_BADREC||Specified record number is invalid, i.e., smaller than 1 or larger than the number of records currently allocated.
+
|-3||d_BADREC||Specified record number is invalid, i.e., smaller than 1 or larger than the number of records currently allocated.
 
|-
 
|-
|-4||d_WTFAIL||File write operation failed.
+
|-4||d_WTFAIL||File write operation failed.
 
|-
 
|-
|-5||d_NONDX||File does not have a valid .NDX file structure.
+
|-5||d_NONDX||File does not have a valid .NDX file structure.
 
|-
 
|-
 
|-6||d_KYLONG||Key expression is too long
 
|-6||d_KYLONG||Key expression is too long
 
|-
 
|-
|-7||d_NOKEY||Needed key is not found in the specified .NDX file or the .NDX file is empty.
+
|-7||d_NOKEY||Needed key is not found in the specified .NDX file or the .NDX file is empty.
 
|-
 
|-
|-8||d_MAYBE||Needed key not found in the specified .NDX file, but the key that may immediately follow the requested key was located.
+
|-8||d_MAYBE||Needed key not found in the specified .NDX file, but the key that may immediately follow the requested key was located.
 
|-
 
|-
|-9||d_ENDKEY||Access pointer reached the end of the specified .NDX file.
+
|-9||d_ENDKEY||Access pointer reached the end of the specified .NDX file.
 
|-
 
|-
|-10||d_NOSYNC||Key exists in the .NDX file, but its corresponding record does not exist in the specified .DBF file.
+
|-10||d_NOSYNC||Key exists in the .NDX file, but its corresponding record does not exist in the specified .DBF file.
 
|-
 
|-
|-11||d_TOPKEY||Access pointer is positioned at the top of the specified .NDX file.
+
|-11||d_TOPKEY||Access pointer is positioned at the top of the specified .NDX file.
 
|-
 
|-
|-12||d_LOCKFAILED||Lock operation failed.
+
|-12||d_LOCKFAILED||Lock operation failed.
 
|-
 
|-
|-13||d_UNLOCKFAILED||Unlock operation failed.
+
|-13||d_UNLOCKFAILED||Unlock operation failed.
 
|-
 
|-
|-14||d_ALREADYLOCKED||Database (or record) has already been locked by another user.
+
|-14||d_ALREADYLOCKED||Database (or record) has already been locked by another user.
 
|-
 
|-
|-15||d_NOLICENCE||User is not licensed to perform the requested operation.
+
|-15||d_NOLICENCE||User is not licensed to perform the requested operation.
 
|-
 
|-
|-16||d_NOTLOCKED||Reserved for future use.
+
|-16||d_NOTLOCKED||Reserved for future use.
 
|-
 
|-
|-17||d_NODBX||File does not have a valid .DBX structure.
+
|-17||d_NODBX||File does not have a valid .DBX structure.
 
|-
 
|-
|-18||d_TAGERROR||Invalid tag name or number specified.
+
|-18||d_TAGERROR||Invalid tag name or number specified.
 
|-
 
|-
|-19||d_SHARED||Table opened shared, operation requires exclusive use.
+
|-19||d_SHARED||Table opened shared, operation requires exclusive use.
 
|-
 
|-
|-20||d_MEMORY||Insufficient memory.
+
|-20||d_MEMORY||Insufficient memory.
 
|-
 
|-
 
|}
 
|}

Latest revision as of 13:58, 31 March 2009

The include file "dbl.h" contains symbolic definitions for the values that can be returned by RECITAL/Library functions.

An application program should refer to these values when checking return values from RECITAL/Library functions. A list of the symbols and their assigned numeric values follows:-


VALUE SYMBOLS DESCRIPTION
0 SUCCESS Function executed successfully
-1 d_ERROR A function returns –1 if it failed due to fundamental reasons such as wrong input values or the file to be accessed is closed or disk I/O operations failed because of a System limitation such as "disk full".
-2 d_NODBF File does not have a valid .DBF file structure.
-3 d_BADREC Specified record number is invalid, i.e., smaller than 1 or larger than the number of records currently allocated.
-4 d_WTFAIL File write operation failed.
-5 d_NONDX File does not have a valid .NDX file structure.
-7 d_NOKEY Needed key is not found in the specified .NDX file or the .NDX file is empty.
-8 d_MAYBE Needed key not found in the specified .NDX file, but the key that may immediately follow the requested key was located.
-9 d_ENDKEY Access pointer reached the end of the specified .NDX file.
-10 d_NOSYNC Key exists in the .NDX file, but its corresponding record does not exist in the specified .DBF file.
-11 d_TOPKEY Access pointer is positioned at the top of the specified .NDX file.
-12 d_LOCKFAILED Lock operation failed.
-13 d_UNLOCKFAILED Unlock operation failed.
-14 d_ALREADYLOCKED Database (or record) has already been locked by another user.
-15 d_NOLICENCE User is not licensed to perform the requested operation.
-16 d_NOTLOCKED Reserved for future use.
-17 d_NODBX File does not have a valid .DBX structure.
-18 d_TAGERROR Invalid tag name or number specified.
-19 d_SHARED Table opened shared, operation requires exclusive use.
-20 d_MEMORY Insufficient memory.