opensolaris man page for ssastringcpy

SSAStringCpy(3SNMP)					      SNMP Library Functions					       SSAStringCpy(3SNMP)

NAME
       SSAStringCpy, SSAStringInit, SSAStringToChar, SSAStringZero - Sun Solstice Enterprise Agent string helper functions

SYNOPSIS
       cc [ flag ... ] file ... -lssasnmp [ library .. ]
       #include <impl.h>

       void *SSAStringZero(String *string);

       int SSAStringInit(String *string, uchar_t *chars, int len,
	    char *error_label);

       int SSAStringCpy(String *string1, String *string2, char *error_label);

       char *SSAStringToChar(String string);

DESCRIPTION
       The  SSAStringCpy()  function  makes  a deep copy of string2 to string1. This function assumes that string1 has been processed by the SSAS-
       tringZero() function. Memory is allocated inside the string1 and the contents of string2, not just the pointer, is copied to  the  string1.
       If an error is encountered, an error message is stored in the error_label buffer.

       The  SSAStringInit()  function copies the char array from chars to the string instance with the specified length len. This function assumes
       that the string instance has been processed by the SSAStringZero() function or no memory is allocated inside the  string  instance.  If	an
       error is encountered, an error message is stored in the error_label buffer.

       The SSAStringToChar() function returns a temporary char array buffer for printing purposes.

       The SSAStringZero() function frees the memory inside of the String instance, but not the string object itself.

RETURN VALUES
       The SSAStringInit() and SSAStringCpy() functions return 0 if successful and -1 if error.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Obsolete			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       attributes(5)

SunOS 5.11							    30 Apr 2006 					       SSAStringCpy(3SNMP)