Function _storclen() | Xbase++

Assigns a character string of explicit length to a parameter.

BOOL _storclen(CHAR *pBuffer, ULONG ulSize,
               XppParamList pList, ULONG ulIndex, ...);

CHAR *pBuffer

Pointer to a string which is copied into the parameter.

ULONG ulSize

Length of the string which is to be copied.

XppParamList pList

Pointer to the Xbase++ parameter list, which is used to provide access to the parameter.

ULONG ulIndex

Position of the parameter which is to be modified (first parameter is 1).

...

The remaining arguments are only considered when the parameter is an array. They must be of ULONG type. To select an element of the array an index is specified for each array dimension. If the array value itself should be replaced, NULL must be specified as the first value. Note:The end of the array index list must be indicated by incorporating a NULL as the last value in the list.

If the string is copied successfully, the function returns TRUE. If the return value is FALSE, not enough memory is available for the string to be copied.

The function _storclen() is used to assign a string which may contain NULL characters to a parameter. The string is copied up to the indicated length including NULL characters. It can, therefore, be overwritten after a call of the function. This function is normally used along with parameters passed by reference to return multiple values to the calling function. However, the changed parameters can also be accessed again within the C function.

/* 
Assigns a new value to the first three parameters. 
*/ 
#include <xpppar.h> 
#include <stdlib.h> 

CHAR  buffer[80]; 
ULONG num; 

for (num = 1; num < 3; num++) 
{ 
sprintf(buffer, "New value for parameter %d", num); 
storclen(buffer, strlen(buffer), <pList>, num, 0); 
}

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.

Function _storclen() Foundation