ACTIVESWLib::ISPSmartCardDriver Interface Reference
Detailed Description
SignWare Dynamic Development toolkit, ActiveX wrapper for SPSmartcardDriverInterface
ISPSmartCardDriver.
Enumerate all available smartcard readers, and select a reader for further smartcard access.
|
Public Member Functions |
| HRESULT | Clone ([out] ISPSmartCardDriver **ppSmartcardDriver,[out, retval] long *result) |
| | Create a copy of a Smartcard driver object.
|
| HRESULT | CreateByCompanyName ([in] BSTR pszCompanyName,[out, retval] long *result) |
| | Query a Smartcard driver object that equals the company name.
|
| HRESULT | CreateByDeviceName ([in] BSTR pszDeviceName,[out, retval] long *result) |
| | Query a Smartcard driver object that equals the driver name.
|
| HRESULT | CreateByIndex ([in] long iNrDriver,[out, retval] long *result) |
| | Query a Smartcard driver object.
|
| HRESULT | GetCompanyName ([out] BSTR *pszCompanyName,[in] long iCompanyNameLength,[out, retval] long *result) |
| | Query the company name from a Smartcard driver object.
|
| HRESULT | GetDeviceName ([out] BSTR *pszDeviceName,[in] long iDeviceNameLength,[out, retval] long *result) |
| | Query the driver name from a Smartcard driver object.
|
| HRESULT | GetNumberDrivers ([out] long *piNrDrivers,[out, retval] long *result) |
| | Query the number of Smartcard drivers found in the system.
|
| HRESULT | GetTerminal ([out] long *piDriverTerminal,[out, retval] long *result) |
| | Query the driver terminal number from a Smartcard driver object.
|
| HRESULT | GetVersion ([out] BSTR *pszVersion,[out, retval] long *result) |
| | Query the driver version from a Smartcard driver object.
|
Member Function Documentation
| HRESULT ACTIVESWLib::ISPSmartCardDriver::Clone |
( |
[out] ISPSmartCardDriver ** |
ppSmartcardDriver, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Create a copy of a Smartcard driver object.
- Parameters:
-
| ppSmartcardDriver | [o] A pointer to a pSPSMARTCARDDRIVER_T object, that will be filled with the requested driver data. |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardCreateByIndex, SPSmartcardFreeDriver
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::CreateByCompanyName |
( |
[in] BSTR |
pszCompanyName, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query a Smartcard driver object that equals the company name.
- Parameters:
-
| pszCompanyName | [i] Name of the company. |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardGetDriverNumber
SPSmartcardFreeDriver
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::CreateByDeviceName |
( |
[in] BSTR |
pszDeviceName, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query a Smartcard driver object that equals the driver name.
- Parameters:
-
| pszDeviceName | [i] Name of the driver. |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardGetDriverNumber
SPSmartcardFreeDriver
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::CreateByIndex |
( |
[in] long |
iNrDriver, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query a Smartcard driver object.
- Parameters:
-
| iNrDriver | [i] The index of the driver. |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardGetDriverNumber
SPSmartcardFreeDriver
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::GetCompanyName |
( |
[out] BSTR * |
pszCompanyName, |
|
|
[in] long |
iCompanyNameLength, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the company name from a Smartcard driver object.
- Parameters:
-
| pszCompanyName | [o] A pointer to a memory region that will be filled with the Company name as a zero terminated string. |
| iCompanyNameLength | [i] Number of bytes in the memory region |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardCreateByIndex, SPSmartcardCreateByCompanyName, SPSmartcardCreateByDriverName
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::GetDeviceName |
( |
[out] BSTR * |
pszDeviceName, |
|
|
[in] long |
iDeviceNameLength, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the driver name from a Smartcard driver object.
- Parameters:
-
| pszDeviceName | [o] A pointer to a memory region that will be filled with the device name as a zero terminated string. |
| iDeviceNameLength | [i] Number of bytes in the memory region |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardCreateByIndex, SPSmartcardCreateByCompanyName, SPSmartcardCreateByDriverName
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::GetNumberDrivers |
( |
[out] long * |
piNrDrivers, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the number of Smartcard drivers found in the system.
- Parameters:
-
| piNrDrivers | [o] pointer to a SPINT32, that will be filled with the number of drivers found in the system. |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- Note:
- The function returns the number of drivers that are installed. There may be drivers without a physical reader connected.
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::GetTerminal |
( |
[out] long * |
piDriverTerminal, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the driver terminal number from a Smartcard driver object.
- Parameters:
-
| piDriverTerminal | [o] A pointer to an integer that will be filled with the device terminal number. |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardCreateByIndex, SPSmartcardCreateByCompanyName, SPSmartcardCreateByDriverName
|
| HRESULT ACTIVESWLib::ISPSmartCardDriver::GetVersion |
( |
[out] BSTR * |
pszVersion, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the driver version from a Smartcard driver object.
- Parameters:
-
| pszVersion | [o] A pointer to a memory region that will be filled with the driver version as a zero terminated string. |
| result | [io] pointer to an long that will be filled with the SDK result, if the functions returns S_OK |
- Returns:
- 0: success, else error code
errors:
- SP_PARAMERR invalid parameter
- SP_MEMERR no more memory
- See also:
- SPSmartcardCreateByIndex, SPSmartcardCreateByCompanyName, SPSmartcardCreateByDriverName
|
The documentation for this interface was generated from the following file:
