Previous Topic: SmQueryVersion()Next Topic: SmTunnelRelease()

Programming Guides › Programming Guide for C › Tunnel Service API Guidance › Authentication Scheme Configuration › SmTunnelInit()

SmTunnelInit()

SiteMinder calls this function so that a tunnel service can perform its own initialization procedure. This call is made once when the tunnel service is loaded for the first time. The information is cached for subsequent use.

Syntax

int SM_EXTERN SmTunnelInit (
   void**                     ppServiceHandle,
   const Sm_Api_Context_t*    lpApiContext,
   const int                  nBytesStatusBuf,
   char*                      lpszStatusBuf
);

Parameter

I/O

Description

ppServiceHandle

I

An internal pointer used by the tunnel service library.

lpApiContext

I

A pointer to the API context structure.

nBytesStatusBuf

O

Maximum size of the output status buffer.

lpszStatusBuf

O

Output buffer receives any status messages from the tunnel service.

Returns

Returns 0 if successful or -1 if unsuccessful.