User manual REDHAT NETSCAPE ENTERPRISE SERVER 6.1 NSAPI PROGRAMMER GUIDE

[. . . ] NSAPI Programmer's Guide Netscape Enterprise Server Version 6. 1 April 2002 (Draft) Netscape Communications Corporation ("Netscape") and its licensors retain all ownership rights to the software programs offered by Netscape (referred to herein as "Software") and related documentation. Use of the Software and related documentation is governed by the license agreement for the Software and applicable copyright law. Your right to copy this documentation is limited by copyright law. Making unauthorized copies, adaptations or compilation works is prohibited and constitutes a punishable violation of the law. [. . . ] The name and value parameters are copied. Syntax pb_param *pblock_nninsert(char *name, int value, pblock *pb); Returns A pointer to the new pb_param structure. Parameters char *name is the name of the new entry. int value is the numeric value being inserted into the pblock. If the value you assign is not a number, then instead use the function pblock_nvinsert to create the parameter. pblock *pb is the pblock into which the insertion occurs. See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock pblock_nvinsert The pblock_nvinsert function creates a new entry with a given name and character value in the specified pblock. The name and value parameters are copied. Syntax pb_param *pblock_nvinsert(char *name, char *value, pblock *pb); 162 Netscape Enterprise Server NSAPI Programmer's Guide · April 2002 (Draft) NSAPI Functions (in Alphabetical Order) Returns A pointer to the newly allocated pb_param structure Parameters char *name is the name of the new entry. char *value is the string value of the new entry. pblock *pb is the pblock into which the insertion occurs. Example pblock_nvinsert("content-type", "text/html", rq->srvhdrs); See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nninsert, pblock_remove, pblock_str2pblock pblock_pb2env The pblock_pb2env function copies a specified pblock into a specified environment. The function creates one new environment entry for each name-value pair in the pblock. Use this function to send pblock entries to a program that you are going to execute. Syntax char **pblock_pb2env(pblock *pb, char **env); Returns A pointer to the environment. Parameters pblock *pb is the pblock to be copied. char **env is the environment into which the pblock is to be copied. See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock pblock_pblock2str The pblock_pblock2str function copies all parameters of a specified pblock into a specified string. The function allocates additional non-heap space for the string if needed. Use this function to stream the pblock for archival and other purposes. Chapter 5 NSAPI Function Reference 163 NSAPI Functions (in Alphabetical Order) Syntax char *pblock_pblock2str(pblock *pb, char *str); Returns The new version of the str parameter. If str is NULL, this is a new string; otherwise it is a reallocated string. In either case, it is allocated from the request's memory pool. Parameters pblock *pb is the pblock to be copied. char *str is the string into which the pblock is to be copied. It must have been allocated by MALLOC or REALLOC, not by PERM_MALLOC or PERM_REALLOC (which allocate from the system heap). Each name-value pair in the string is separated from its neighbor pair by a space and is in the format name="value". See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock pblock_pinsert The function pblock_pinsert inserts a pb_param structure into a pblock. Syntax void pblock_pinsert(pb_param *pp, pblock *pb); Returns void Parameters pb_param *pp is the pb_param structure to insert. See also pblock_copy, pblock_create, pblock_find, pblock_free, pblock_nvinsert, pblock_remove, pblock_str2pblock 164 Netscape Enterprise Server NSAPI Programmer's Guide · April 2002 (Draft) NSAPI Functions (in Alphabetical Order) pblock_remove The pblock_remove function removes a specified name-value entry from a specified pblock. If you use this function you should eventually call param_free in order to deallocate the memory used by the pb_param structure. Syntax pb_param *pblock_remove(char *name, pblock *pb); Returns A pointer to the named pb_param structure, if it was found or NULL if the named pb_param was not found. Parameters char *name is the name of the pb_param to be removed. pblock *pb is the pblock from which the name-value entry is to be removed. [. . . ] PRUint32 flags is ORed directives for this function (see Flags). Request *rq is a pointer to the request. Session *sn is a pointer to the session. Flags DR_NONE specifies that no cache is used, so the function works as net_write does; DrHdl can be NULL. [. . . ]