C API

The following C functions are new (or newly-documented) for Version 2.1 and are described in detail in the alphabetic "C API Function Reference" beginning on C API Function Reference of the C Developer's Guide.

Core Functions

These functions are available regardless of which modules are or are not loaded.

Function	Description
Ns_TclEval	Execute a Tcl script

Ns_Set Structure Functions

These functions manipulate Ns_Set functions:

Function	Description
Ns_SetIUnique	Check if a key in an Ns_Set is unique (case insensitive)
Ns_SetUnique	Check if a key in an Ns_Set is unique (case sensitive)
Ns_TclEnterSet	Make an Ns_Set accessible through Tcl
Ns_TclFreeSet	Free an Ns_Set
Ns_TclGetSet	Return the Ns_Set for the specified set ID
Ns_TclGetSet2	Return the Ns_Set for the specified set ID in a pointer

Scheduled Procedures Functions

These functions allow you to specify a procedure to be run daily, weekly, or at specified intervals

Function	Description
Ns_ScheduleDaily	Schedule a procedure to run once a day
Ns_ScheduleProcEx	Schedule a procedure to run at specified intervals
Ns_ScheduleWeekly	Schedule a procedure to run once a week
Ns_UnscheduleProc	Stop a scheduled procedure

Sockets Interface

The following functions are available for managing sockets.

Function	Description
Ns_ClearSockErrno	Clear error number for socket connection
Ns_GetSockErrno	Get error number for socket connection
Ns_SetSockErrno	Set error number for socket connection
Ns_SockAsyncConnect	Create a remote socket and return immediately
Ns_SockCallback	Register a socket callback function
Ns_SockCloseLater	Close a remote socket which has not yet timed out
Ns_SockConnect	Create a socket to remote host and port
Ns_SockListen	Create a socket on a specified address and port
Ns_SockPipe	Return a pair of connected sockets
Ns_SockSetBlocking	Set a socket in blocking mode
Ns_SockSetNonBlocking	Set a socket in nonblocking mode
Ns_SockStrError	Return string for socket error number
Ns_SockTimedConnect	Create a remote socket within a specified time

Database Services Functions

These functions are available only if the database services are active.

Function	Description
Ns_DbBindRow	Return an Ns_Set structure of columns to be returned by the previously-executed SQL command
Ns_DbExec	Execute an SQL command

Server-Parsed HTML Functions

These functions are available for server-parsed HTML.

Function	Description
Ns_RegisterShtmlCmd	Register a new server-parsed HTML command.

Top of Page
Copyright © 1996 America Online, Inc.