IWCNDevice::SetPassword method (wcndevice.h)

Article
02/22/2024

The IWCNDevice::SetPassword method configures the authentication method value, and if required, a password used for the pending session. This method may only be called prior to IWCNDevice::Connect.

Syntax

HRESULT SetPassword(
  [in] WCN_PASSWORD_TYPE Type,
  [in] DWORD             dwPasswordLength,
  [in] const BYTE []     pbPassword
);

Parameters

[in] Type

A WCN_PASSWORD_TYPE value that specifies the authentication method used for the session.

Value	Meaning
WCN_PASSWORD_TYPE_PUSH_BUTTON	Use PushButton authentication. The value of dwPasswordLength must be NULL.
WCN_PASSWORD_TYPE_PIN	Use PIN-based authentication.

[in] dwPasswordLength

Number of bytes in the buffer pbPassword.

[in] pbPassword

A byte array of the password, encoded in ASCII.

Return value

This method can return one of these values.

Return code	Description
S_OK	The password will be used for the pending session.
E_INVALIDARG	The password type is WCN_PASSWORD_TYPE_PUSH_BUTTON and the password length is not zero. The password type is not WCN_PASSWORD_TYPE_PUSH_BUTTON or WCN_PASSWORD_TYPE_PIN.

Remarks

The byte array is not NULL-terminated. For example, if the password is a 4-digit PIN, you should pass dwPasswordLength as 4 and pbPassword should point to a 4-byte array containing the PIN in ASCII.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	wcndevice.h