Edit

Share via

PROPSPEC structure (propidlbase.h)

  • Article

The PROPSPEC structure is used by many of the methods of IPropertyStorage to specify a property either by its property identifier (ID) or the associated string name.

Syntax

typedef struct tagPROPSPEC {
  ULONG ulKind;
  union {
    PROPID   propid;
    LPOLESTR lpwstr;
  } DUMMYUNIONNAME;
} PROPSPEC;

Members

ulKind

Indicates the union member used. This member can be one of the following values.

Name Meaning
PRSPEC_LPWSTR
Value: 0
 The lpwstr member is used and set to a string name.
PRSPEC_PROPID
Value: 1
 The propid member is used and set to a property ID value.

DUMMYUNIONNAME

DUMMYUNIONNAME.propid

Specifies the value of the property ID. Use either this value or the following lpwstr, not both.

DUMMYUNIONNAME.lpwstr

Specifies the string name of the property as a null-terminated Unicode string.

Remarks

String names are optional and can be assigned to a set of properties when the property is created with a call to IPropertyStorage::WriteMultiple or later with a call to IPropertyStorage::WritePropertyNames.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Header propidlbase.h (include Propidl.h)

See also

IPropertyStorage