IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


int SSI_Register_Tag ( const char *  tagStr,
SSI_Handler  handler,
int  server 
)

This function registers a Server Side Include (SSI) tag string.

Parameters:
tagStr Pointer to null-terminated tag string
handler Pointer to callback function.

Callback function prototype:

 typedef int (* SSI_Handler) (unsigned long conhandle, const char * tagPtr);

Possible callback function return values:

 SSI_OUTPUT_ENABLE (0x00) = Enable web server to output static content
 SSI_OUTPUT_DISABLE (0x01) = Disable web server to output static content
 SSI_ABORT_PAGE (0x02) = Stop processing the current file
 other = The web server will send an error message and stop serving the HTTP request
server 0 = register for HTTP server, 1 = register for HTTPS (SSL) server
Returns:
zero on success, non-zero on failure. Return value contains error code CGI_INVALID_ARGUMENT, CGI_INVALID_METHOD or CGI_NO_FREE_ENTRY.
Note:
Currently only one tag per server can be registered.
Since:
SC2x3 V1.00 - CLIB V1.00
See also:
SSI_Set_File_Filter() SSI_Set_TagLength() SSI_Send_Buffer()





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:38 2017 by Doxygen 1.6.1