Unit test status code discrepancies in osapi-file.h

[jphickey]

Is your feature request related to a problem? Please describe.
The unit tests and API documentation should match, where all status codes in the API documentation are tested in a unit test, and likewise all codes being tested for are documented in the API.

Describe the solution you'd like
Resolve the following mismatches:

File src/os/inc/osapi-file.h, function OS_OpenCreate():

• OK: OS_ERROR
• ONLY IN TEST: OS_ERR_NO_FREE_IDS
• ONLY IN TEST: OS_FS_ERR_NAME_TOO_LONG
• ONLY IN TEST: OS_FS_ERR_PATH_INVALID
• ONLY IN TEST: OS_FS_ERR_PATH_TOO_LONG
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_close():

• ONLY IN DOXY: OS_ERROR
• OK: OS_ERR_INVALID_ID
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_read():

• ONLY IN DOXY: 0
• ONLY IN DOXY: OS_ERROR
• OK: OS_ERR_INVALID_ID
• OK: OS_INVALID_POINTER

File src/os/inc/osapi-file.h, function OS_write():

• ONLY IN DOXY: 0
• ONLY IN DOXY: OS_ERROR
• OK: OS_ERR_INVALID_ID
• OK: OS_INVALID_POINTER

File src/os/inc/osapi-file.h, function OS_TimedRead():

• ONLY IN DOXY: 0
• ONLY IN DOXY: OS_ERROR_TIMEOUT
• ONLY IN DOXY: OS_ERR_INVALID_ID
• ONLY IN DOXY: OS_ERR_INVALID_SIZE
• ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-file.h, function OS_TimedWrite():

• ONLY IN DOXY: 0
• ONLY IN DOXY: OS_ERROR_TIMEOUT
• ONLY IN DOXY: OS_ERR_INVALID_ID
• ONLY IN DOXY: OS_ERR_INVALID_SIZE
• ONLY IN DOXY: OS_INVALID_POINTER

File src/os/inc/osapi-file.h, function OS_chmod():
NONE - no specific retvals in API, and no checks in test (possibly need to add).

File src/os/inc/osapi-file.h, function OS_stat():

• OK: OS_ERROR
• ONLY IN DOXY: OS_FS_ERR_NAME_TOO_LONG
• OK: OS_FS_ERR_PATH_INVALID
• OK: OS_FS_ERR_PATH_TOO_LONG
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_lseek():

• OK: OS_ERROR
• OK: OS_ERR_INVALID_ID

File src/os/inc/osapi-file.h, function OS_remove():

• ONLY IN DOXY: OS_ERROR
• OK: OS_FS_ERR_NAME_TOO_LONG
• OK: OS_FS_ERR_PATH_INVALID
• OK: OS_FS_ERR_PATH_TOO_LONG
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_rename():

• ONLY IN DOXY: OS_ERROR
• OK: OS_FS_ERR_NAME_TOO_LONG
• OK: OS_FS_ERR_PATH_INVALID
• OK: OS_FS_ERR_PATH_TOO_LONG
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_cp():

• ONLY IN DOXY: OS_ERROR
• OK: OS_FS_ERR_NAME_TOO_LONG
• OK: OS_FS_ERR_PATH_INVALID
• OK: OS_FS_ERR_PATH_TOO_LONG
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_mv():

• ONLY IN DOXY: OS_ERROR
• OK: OS_FS_ERR_NAME_TOO_LONG
• OK: OS_FS_ERR_PATH_INVALID
• OK: OS_FS_ERR_PATH_TOO_LONG
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_FDGetInfo():

• OK: OS_ERR_INVALID_ID
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_FileOpenCheck():

• OK: OS_ERROR
• OK: OS_INVALID_POINTER
• ONLY IN TEST: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_CloseAllFiles():

• ONLY IN DOXY: OS_ERROR
• OK: OS_SUCCESS

File src/os/inc/osapi-file.h, function OS_CloseFileByName():

• ONLY IN DOXY: OS_ERROR
• OK: OS_FS_ERR_PATH_INVALID
• OK: OS_INVALID_POINTER
• OK: OS_SUCCESS

Additional context
Originally noted in #331, split into separate work items.

Requester Info
Joseph Hickey, Vantage Systems, Inc.