visit Kofax web site

ACTIVESWLib::ISPTicket Interface Reference


Detailed Description

SignWare Dynamic Development toolkit, ActiveX wrapper for SPTicketInterface ISPTicket.

Create / charge license tickets

Note:
SignWare now uses license keys, usage of license tickets is deprecated. The following description only applies if you still use ticket license files.


Public Member Functions

HRESULT Charge ([out, retval] long *result)
 Charge a ticket structure.
HRESULT Create ([in] long usage,[in] long iCount,[in] BSTR bstrSession,[out, retval] long *result)
 Create a new ticket structure.
HRESULT CreateFromFlatFile ([in] ISPFlatFile *pFlatFile,[out, retval] long *result)
 Create a SPTicket object from a serialized ticket.
HRESULT GetCount ([out] long *plCount,[out, retval] long *result)
 Query the count for this ticket object.
HRESULT GetSession ([out] BSTR *pbstrSession,[out, retval] long *result)
 Query the session identifier for this ticket object.
HRESULT GetUsage ([out] long *plUsage,[out, retval] long *result)
 Query the usage for this ticket object.
HRESULT SetCount ([in] long lCount,[out, retval] long *result)
 set the requested count for this ticket object
HRESULT SetSession ([in] BSTR bstrSession,[out, retval] long *result)
 set the session identifier for this ticket object
HRESULT SetUsage ([in] long lUsage,[out, retval] long *result)
 set the usage for this ticket object


Member Function Documentation

HRESULT ACTIVESWLib::ISPTicket::Charge [out, retval] long *  result  ) 
 

Charge a ticket structure.

Deprecated:
Please use a license key.
Parameters:
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPTicket::Create [in] long  usage,
[in] long  iCount,
[in] BSTR  bstrSession,
[out, retval] long *  result
 

Create a new ticket structure.

Deprecated:
Please use a license key.
Parameters:
usage [i] intended usage for this ticket, see SPTicketAction
iCount [i] number of requested tickets. Use GetCount() to query the number of granted tickets
bstrSession [i] session identifier where applicable, else NULL
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPTicket::CreateFromFlatFile [in] ISPFlatFile pFlatFile,
[out, retval] long *  result
 

Create a SPTicket object from a serialized ticket.

Deprecated:
Please use a license key.
Parameters:
pFlatFile [i] the flatfile representation of a ticket
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPTicket::GetCount [out] long *  plCount,
[out, retval] long *  result
 

Query the count for this ticket object.

Deprecated:
Please use a license key.
Parameters:
plCount [o] Pointer to a long that will be filled with the count
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result
Note:
The returned count equals the requested ticket count if the ticket was not charged, and the granted count if the ticket was charged

HRESULT ACTIVESWLib::ISPTicket::GetSession [out] BSTR *  pbstrSession,
[out, retval] long *  result
 

Query the session identifier for this ticket object.

Deprecated:
Please use a license key.
Parameters:
pbstrSession [o] Pointer to a long that will be filled with the session identifier
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPTicket::GetUsage [out] long *  plUsage,
[out, retval] long *  result
 

Query the usage for this ticket object.

Deprecated:
Please use a license key.
Parameters:
plUsage [o] Pointer to a long that will be filled with the usage, see SPTicketAction.
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPTicket::SetCount [in] long  lCount,
[out, retval] long *  result
 

set the requested count for this ticket object

Deprecated:
Please use a license key.
Parameters:
lCount [i] the count
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPTicket::SetSession [in] BSTR  bstrSession,
[out, retval] long *  result
 

set the session identifier for this ticket object

Deprecated:
Please use a license key.
Parameters:
bstrSession [i] the session identifier
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result

HRESULT ACTIVESWLib::ISPTicket::SetUsage [in] long  lUsage,
[out, retval] long *  result
 

set the usage for this ticket object

Deprecated:
Please use a license key.
Parameters:
lUsage [i] the usage, see SPTicketAction
result [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
Returns:
automation result


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