USBD_Vendor_MS_ExtPropertyAdd

Description

Adds a Microsoft OS extended property to a vendor class instance.

Files

usbd_vendor.h / usbd_vendor.c

Prototype

void  USBD_Vendor_MS_ExtPropertyAdd (       CPU_INT08U   class_nbr,
                                            CPU_INT08U   property_type,
                                     const  CPU_INT08U  *p_property_name,
                                            CPU_INT16U   property_name_len,
                                     const  CPU_INT08U  *p_property,
                                            CPU_INT32U   property_len,
                                            USBD_ERR    *p_err)

Arguments

class_nbr

Class instance number.

property_type

Property type.

USBD_MS_OS_PROPERTY_TYPE_REG_SZ

USBD_MS_OS_PROPERTY_TYPE_REG_EXPAND_SZ

USBD_MS_OS_PROPERTY_TYPE_REG_BINARY

USBD_MS_OS_PROPERTY_TYPE_REG_DWORD_LITTLE_ENDIAN

USBD_MS_OS_PROPERTY_TYPE_REG_DWORD_BIG_ENDIAN

USBD_MS_OS_PROPERTY_TYPE_REG_LINK

USBD_MS_OS_PROPERTY_TYPE_REG_MULTI_SZ

p_property_name

Pointer to buffer that contains property name.

property_name_len

Length of property name in octets.

p_property

Pointer to buffer that contains property.

property_len

Length of property in octets.

p_err

Pointer to variable that will receive the return error code from this function.

USBD_ERR_NONE

USBD_ERR_INVALID_ARG

USBD_ERR_NULL_PTR

Returned Value

None.

Callers

Application.

Notes / Warnings

1. For more information on Microsoft OS descriptors, see http://msdn.microsoft.com/en-us/library/windows/hardware/gg463179.aspx.
2. For more information on property types, refer to "Table 3. Property Data Types" of "Extended Properties OS Feature Descriptor Specification" document provided by Microsoft available at http://msdn.microsoft.com/en-us/library/windows/hardware/gg463179.aspx.
3. Microsoft OS descriptors must be enabled by setting USBD_CFG_MS_OS_DESC_EN to DEF_ENABLED before using this function.