Share via


OBEX_HEADER (Compact 2013)

3/26/2014

This structure is used to enumerate headers in a collection.

Syntax

typedef struct _OBEX_HEADER {
  byte bId;
  [switch_is(bId & OBEX_HEADER_4BYTE)]
  union {
    [case(OBEX_HEADER_UNICODE)] 
    [string] LPWSTR pszData;
    [case(OBEX_HEADER_4BYTE)] 
    DWORD dwData;
    [case(OBEX_HEADER_1BYTE)] 
    byte bData;
    [case(OBEX_HEADER_STREAM)] 
    struct {
      DWORD dwSize; 
      [size_is(dwSize)] byte* pbaData;
    } ba; 
  } value; 
} OBEX_HEADER;

Members

  • bId
    Identifier of the header.
  • pszData
    Data size of the header.
  • dwData
    Header data available.
  • bData
    Used when there is just one byte of data.
  • dwSize
    Size of the byte array.
  • pbaData
    Pointer to the data details.

Remarks

Depending on the type of header (OBEX_HEADER_UNICODE, OBEX_HEADER_STREAM, OBEX_HEADER_1BYTE, and OBEX_HEADER_1BYTE) defined by the bId member, specific fields should be used. If the stream type is OBEX_HEADER_STREAM, the pbaData member will need to be released with the CoTaskMemFree function call.

Requirements

Header

obex.h,
obex.idl

See Also

Reference

OBEX Structures

Other Resources

CoTaskMemFree