Edit

KSPROPERTY_VALUES structure (ks.h)

  • Article

The KSPROPERTY_VALUES structure describes the type and acceptable default values of a property.

Syntax

typedef struct {
  KSIDENTIFIER                 PropTypeSet;
  ULONG                        MembersListCount;
  const KSPROPERTY_MEMBERSLIST *MembersList;
} KSPROPERTY_VALUES, *PKSPROPERTY_VALUES;

Members

PropTypeSet

Specifies a KSIDENTIFIER structure (see KSEVENT) that identifies the data type of the property. The Set member of a KSIDENTIFIER structure indicates the set of value types supported, and the Id member of the same structure identifies the type within the set.

MembersListCount

Specifies the number of entries in the array pointed to by MembersList.

MembersList

Points to an array of KSPROPERTY_MEMBERSLIST structures. Each entry specifies a list of possible values or sets of values that the property may assume.

Remarks

PropTypeSet.Set almost always equals KSPROPTYPESETID_General. The individual value types in KSPROPTYPESETID_General correspond to the VARENUM enumeration types.

Possible values for PropTypeSet.Id in streaming media (audio/camera) include:

Value Data type
VT_BLOB Length-prefixed bytes.
VT_BOOL A Boolean value. True is -1 and false is 0.
VT_CLSID A class ID.
VT_I4 A 4-byte integer.
VT_ILLEGAL An illegal value.
VT_LPWSTR A wide null-terminated string.
VT_R8 An 8-byte real.
VT_UI1 An unsigned character.
VT_UI2 An unsigned short.
VT_UI4 An unsigned 4-byte integer.
VT_UI8 An unsigned 8-byte integer.

For more information, see the VARENUM enumeration.

A driver can specify a pointer to a KSPROPERTY_VALUES structure in the relevant KSPROPERTY_ITEM for a property.

For more information, see KS Properties.

Requirements

Requirement Value
Header ks.h (include Ks.h)

See also

KSEVENT

KSPROPERTY_DESCRIPTION

KSPROPERTY_ITEM

KSPROPERTY_MEMBERSLIST

VARENUM