IWCNDevice::GetStringAttribute method (wcndevice.h)

  • Article

The IWCNDevice::GetStringAttribute method gets a cached attribute from the device as a string.

Syntax

HRESULT GetStringAttribute(
  [in]  WCN_ATTRIBUTE_TYPE AttributeType,
  [in]  DWORD              cchMaxString,
  [out] WCHAR []           wszString
);

Parameters

[in] AttributeType

A WCN_ATTRIBUTE_TYPE value that represents a specific attribute value (for example, WCN_PASSWORD_TYPE). If the attribute is not natively a string data type (for example, WCN_TYPE_VERSION is natively an integer, and WNC_TYPE_SSID is natively a blob), this function will fail with HRESULT_FROM_WIN32(ERROR_INVALID_DATATYPE).

[in] cchMaxString

The size of the buffer wszString, in characters.

[out] wszString

A user-allocated buffer that, on successful return, contains a NULL-terminated string value of the vendor extension.

Return value

...

Return code Description
S_OK
 The attribute was retrieved successfully.
HRESULT_FROM_WIN32(ERROR_NOT_FOUND)
 The attribute specified is not available.
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)
 The buffer specified by wszString is not large enough to contain the returned attribute value.
HRESULT_FROM_WIN32(ERROR_INVALID_DATATYPE)
 This attribute cannot be expressed as a string. For example, if it is an integer.

Requirements

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

See also

IWCNDevice

WCN_ATTRIBUTE_TYPE