CreatePassword Method
Creates a Time-Based or HMAC-Based One Time Password.
Syntax
ANSI (Cross Platform) int CreatePassword(); Unicode (Windows) INT CreatePassword();
- (void)createPassword;
#define MID_ONETIMEPASSWORD_CREATEPASSWORD 3 IPWORKSAUTH_EXTERNAL int IPWORKSAUTH_CALL IPWorksAuth_OneTimePassword_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This method creates either a Time-Based or HMAC-Based One Time Password. The PasswordAlgorithm property specifies which algorithm to use.
The following properties are applicable when calling CreatePassword.
- PasswordAlgorithm
- Secret
- Counter (required for HMAC-Based One Time Password)
- TimeStep (applicable for Time-Based One Time Password)
Calling CreatePassword populates the Password property with the created password.
If Secret is not specified before calling this method a random secret will be automatically generated.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)