IWCNDevice::GetAttribute method (wcndevice.h)

  • Article

The IWCNDevice::GetAttribute method gets a cached attribute from the device.

Syntax

HRESULT GetAttribute(
  [in]  WCN_ATTRIBUTE_TYPE AttributeType,
  [in]  DWORD              dwMaxBufferSize,
  [out] BYTE []            pbBuffer,
  [out] DWORD              *pdwBufferUsed
);

Parameters

[in] AttributeType

A WCN_ATTRIBUTE_TYPE value that represents a specific attribute value (for example, WCN_PASSWORD_TYPE).

[in] dwMaxBufferSize

The allocated size, in bytes, of pbBuffer.

[out] pbBuffer

A user-allocated buffer that, on successful return, contains the contents of the attribute.

[out] pdwBufferUsed

On return, contains the size of the attribute in bytes.

Return value

This method can return one of these values.

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 pbBuffer is not large enough to contain the returned attribute value.

Remarks

To only query the size of an attribute, a value of 0 (zero) can be passed via dwMaxBufferSize and pdwBufferUsed will be filled appropriately.

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