OS_GetArgc

C Specification

#include <nitro/os.h>
int OS_GetArgc( void );
 

Arguments

None.

Return Values

The separate arguments including the program name are returned.

However, if argument data is not stored in the argument buffer, zero is returned. If data is stored in the argument buffer and there are no arguments, one is returned.

Description

Returns each argument according to the argument data embedded in the ROM file.

Arguments can be embedded in the ROM file as argument data using the buryarg tool. Since the program name (the ROM file name specified when buryarg executed) is included among the return values of this function, one is returned if there are no arguments.

Zero is returned if no argument data has been embedded.

Always returns zero when FINALROM builds.

See Also

OS_GetArgv, OS_GetOpt, buryarg tool

Revision History

07/21/2005 Initial version.