wxSQLite3  5.0.1
Loading...
Searching...
No Matches
wxSQLite3::Authorizer Class Referenceabstract

Interface for a user defined authorizer function. More...

#include <wxsqlite3.h>

Public Types

enum class  AuthorizationResult {
  SQLITE_OK = 0 ,
  SQLITE_DENY = 1 ,
  SQLITE_IGNORE = 2
}
 Return codes of the authorizer. More...

Public Member Functions

virtual ~Authorizer ()
 Virtual destructor.
virtual AuthorizationResult Authorize (AuthorizationCode type, const wxString &arg1, const wxString &arg2, const wxString &arg3, const wxString &arg4, const wxString &arg5)=0
 Execute the authorizer function.

Static Public Member Functions

static wxString AuthorizationCodeToString (AuthorizationCode type)
 Convert authorization code to string.

Detailed Description

Interface for a user defined authorizer function.

Member Enumeration Documentation

◆ AuthorizationResult

Return codes of the authorizer.

Enumerator
SQLITE_OK 
SQLITE_DENY 
SQLITE_IGNORE 

Constructor & Destructor Documentation

◆ ~Authorizer()

virtual wxSQLite3::Authorizer::~Authorizer ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ AuthorizationCodeToString()

wxString wxSQLite3::Authorizer::AuthorizationCodeToString ( AuthorizationCode type)
static

Convert authorization code to string.

Parameters
typeAuthorizationCode. The value signifies what kind of operation is to be authorized.

◆ Authorize()

virtual AuthorizationResult wxSQLite3::Authorizer::Authorize ( AuthorizationCode type,
const wxString & arg1,
const wxString & arg2,
const wxString & arg3,
const wxString & arg4,
const wxString & arg5 )
pure virtual

Execute the authorizer function.

Please refer to the SQLite documentation for further information about the meaning of the parameters.

Parameters
typeAuthorizationCode. The value signifies what kind of operation is to be authorized.
arg1first argument (value depends on "type")
arg2second argument (value depends on "type")
arg3third argument (name of database if applicable)
arg4fourth argument (name of trigger or view if applicable)
arg5fifth argument (name of authorized user or empty if user authentication is not activated)
Returns
a wxAuthorizationResult, i.e. SQLITE_OK, SQLITE_DENY or SQLITE_IGNORE

The documentation for this class was generated from the following file: