Difference between revisions of "Parnl()"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
Line 15: Line 15:
 
<input parameters>
 
<input parameters>
 
int order; /* Placement in actual parameter list */
 
int order; /* Placement in actual parameter list */
int index; /* Array element index */
+
int index; /* Array element index */
  
 
<output parameters>
 
<output parameters>

Latest revision as of 12:40, 30 March 2009

PURPOSE

Convert a Recital numeric to a long


SYNONYM

api_par_nl()


SYNOPSIS

#include "dbapi.h"
 
long	_parnl(order [,index]))
 
<input parameters>
int	order;		/* Placement in actual parameter list	*/
int	index;		/* Array element index			*/
 
<output parameters>
none


DESCRIPTION

The _parnl() function returns a numeric parameter passed from Recital as a long. The order specifies the actual placement in the parameter list. If the parameter passed is an array, then the optional index value is used to specify the required element number.


EXAMPLE

The following example converts a Recital numeric value passed as the first parameter to a long.

Example Recital program:

m_long=1252
m_long=conlong(m_long)
return

Example 'C' function:

#include "dbapi.h"
 
dbapi_conlong()
{
    long	value;
 
    if ( _parinfo(1) == API_NTYPE ) {
       value = _parnl(1);
    }else {
       value = 0;
    }
 
    _retnl( value );
}


SEE ALSO

_parinfa(), _parinfo(), _parnd(), _parni(), retnd(), _retni(), _retnl(), ISNUM()