Edit

KSPROPERTY_DESCRIPTION structure (ks.h)

  • Article

The KSPROPERTY_DESCRIPTION structure specifies the size and type of values contained in a specific property.

Syntax

typedef struct {
  ULONG        AccessFlags;
  ULONG        DescriptionSize;
  KSIDENTIFIER PropTypeSet;
  ULONG        MembersListCount;
  ULONG        Reserved;
} KSPROPERTY_DESCRIPTION, *PKSPROPERTY_DESCRIPTION;

Members

AccessFlags

Specifies the access allowed to this property. A basic-support request sets this member to the bitwise OR of the flags for all the access types that the handler supports for this property. For a list of possible flag values, see KSPROPERTY.

DescriptionSize

Specifies total size in bytes of the KSPROPERTY_DESCRIPTION structure and any values entries that follow it. If the basic-support property request returns no values entries, this member is the size of KSPROPERTY_DESCRIPTION.

PropTypeSet

A structure of type KSIDENTIFIER. If supported by the specific property, specifies the type of values contained in this property. This group is uniquely specified by a GUID, such that new types of values may be created without overlapping with extensions to this set. The value types indicate the type of the value (like VT_BOOL, VT_UI4 in the standard set). This is GUID_NULL, with an identifier of zero, if values information is not supported by this property.

MembersListCount

Specifies the number of KSPROPERTY_MEMBERSHEADER structures to follow this header.

Reserved

Reserved for future use. Set to zero.

Remarks

A driver returns the KSPROPERTY_DESCRIPTION structure in response to a basic support property request from a client.

The property values type set is specified by a KSIDENTIFIER structure. The basic set supported is KSPROPSETID_General. The identifiers within that set are the standard VARENUM types used for OLE.

The values information that may follow the KSPROPERTY_DESCRIPTION structure is described by a list of KSPROPERTY_MEMBERSLIST structures, each of which contains data range information.

For more information, see KS Properties.

Requirements

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

See also

KSIDENTIFIER

KSPROPERTY

KSPROPERTY_ITEM

KSPROPERTY_MEMBERSHEADER

KSPROPERTY_VALUES