SFLOG_Shutdown

Shutdown and release resources allocated by logging system.

Returns

status code of the operation

Return values

NDK_SUCCESS	Operation successful
NDK_FAILED	Operation unsuccessful. See Macros for full list.

Remarks

• The value of the application name argument (i.e. szAppName) must match the name of the configuration file. The confguration file must exist in the same folder as your application executable file (e.g. MyApp.exe)
• If the value of szLogDir is missing (empty or NULL), the function will use the default temp directory in the current user's profile

Requirements

Header	SFLogger.H
Library	SFLOG.LIB
DLL	SFLOG.DLL

Examples

#include <SFMacros.h>
#include <SFlogger.h>

// Link with SFLOG.lib
#pragma comment("lib", "SFLOG.lib")

using std;

void main(void)
{
  int nRet= NDK_FAILED; 

  string szAppName="MyLogExample";
  string szPath = "C:\\temp";

  nRet = SFLOG_Init( szAppName.c_str(), // Application name (used for log filename (e.g. MyLogExample.log)).
                     szPath.c_str());   // log directory where log files are created
  if( nRet >= NDK_SUCCESS)
  {
    // Is the log system initialization OK?
	....
    
    
    nRet = SFLOG_Shutdown();
  }
     

Shutdown and release resources allocated by logging system.

Return Value

a value from NDK_RETCODE enumeration for the status of the call. 

NDK_SUCCESS	operation successful
Error	Error Code

Remarks

• The logging system uses reference count to manage the system lifetime and support multiple clients to obtain and release access to the system without conditioning on one another in managing the system lifetime.

Exceptions

Exception Type	Condition
None	N/A

Requirements

Namespace	NumXLAPI
Class	SFLOG
Scope	Public
Lifetime	Static
Package	NumXLAPI.DLL

Examples

. . . 
NDK_RETCODE nRet = SFLOG.Shutdown();
. . .