NAME

kjb_strncpy - Copies one string to another

SYNOPSIS

#include "l/l_string.h"

Example compile flags (system dependent):
  -DLINUX_X86_64 -DLINUX_X86_64_OPTERON  -DGNU_COMPILER 
   -I/home/kobus/include
   -L/home/kobus/misc/load/linux_x86_64_opteron -L/usr/lib/x86_64-linux-gnu
  -lKJB                               -lfftw3  -lgsl -lgslcblas -ljpeg  -lSVM -lstdc++                    -lpthread -lSLATEC -lg2c    -lacml -lacml_mv -lblas -lg2c      -lncursesw 


void kjb_strncpy
(
	char *s1,
	const char *s2,
	size_t max_len
);

DESCRIPTION

kjb_strncpy is similar strncpy but s1 always gets null terminated - IE max_len includes the null. Also, assuming that max_len is the size of the storage for s1, this routine will not write beyond that storage, including the null. This routine needs to be able to stop copying based on the length. For a version that returns error on truncation, see kjb_buff_cpy().

RETURNS

Unlike stncpy(), this routine does not return anything. The reason is due to the complexity of getting the interface just right on multiple archetectures given that supporting a negative integer return is nice, but that the number of copied characters is potentially MAX_SIZE_T. However, this might be changed in the future, if we get time to make various components consistent.

MACROS

BUFF_CPY(char s1[], char* s2) The buffer size parameter is set to sizeof(s1). Using sizeof to set the buffer size is recomended where applicable, as the code will not be broken if the buffer size changes. HOWEVER, neither this method, nor the macro, is applicable if s1 is NOT a character array. If s1 is declared by "char* s1", then the size of s1 is the number of bytes in a character pointer (usually 4), which is NOT what is normally intended. You have been WARNED!

kjb_buff_cpy, kjb_buff_cat, kjb_strncat, extended_lc_strncpy, extended_uc_strncpy

DISCLAIMER

This software is not adequatedly tested. It is recomended that results are checked independantly where appropriate.

AUTHOR

Kobus Barnard

DOCUMENTER