OCRASuite Property
The OCRASuite defines parameters about the challenge and response.
Syntax
ANSI (Cross Platform) char* GetOCRASuite();
int SetOCRASuite(const char* lpszOCRASuite); Unicode (Windows) LPWSTR GetOCRASuite();
INT SetOCRASuite(LPCWSTR lpszOCRASuite);
@property (nonatomic,readwrite,assign,getter=OCRASuite,setter=setOCRASuite:) NSString* OCRASuite; - (NSString*)OCRASuite; - (void)setOCRASuite:(NSString*)newOCRASuite;
#define PID_OCRA_OCRASUITE 9 IPWORKSAUTH_EXTERNAL void* IPWORKSAUTH_CALL IPWorksAuth_OCRA_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKSAUTH_EXTERNAL int IPWORKSAUTH_CALL IPWorksAuth_OCRA_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
Default Value
""
Remarks
This property holds the OCRASuite value which defines parameters about the challenge and response.
This property will be populated after calling CreateChallenge. This property must be set before calling CalculateResponse or VerifyResponse.
When calling CreateChallenge the following properties will be used to create the OCRASuite:
- ChallengeFormat
- HashAlgorithm
- ResponseLength
- RequireCounter
- RequirePassword
- RequireTimeStamp
- PasswordHashAlgorithm
- RequireSessionInfo
- SessionInfoLength
- TimeStepSize
- TimeStepUnit
When this property is set the value is parsed and the above properties are populated to reflect the requirements defined by the OCRASuite.
Data Type
String