Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

WS_METADATA_PROPERTY_ID enumeration

Each metadata property is of type WS_METADATA_PROPERTY, is identified by an ID, and has an associated value. If a property is not specified when the metadata is created, then its default value is used.

Syntax


enum WS_METADATA_PROPERTY_ID {  WS_METADATA_PROPERTY_STATE, 
  WS_METADATA_PROPERTY_HEAP_PROPERTIES, 
  WS_METADATA_PROPERTY_POLICY_PROPERTIES, 
  WS_METADATA_PROPERTY_HEAP_REQUESTED_SIZE, 
  WS_METADATA_PROPERTY_MAX_DOCUMENTS, 
  WS_METADATA_PROPERTY_HOST_NAMES, 
  WS_METADATA_PROPERTY_VERIFY_HOST_NAMES 

};

Constants

WS_METADATA_PROPERTY_STATE

This property is used with WsGetMetadataProperty.

The accompanying value member of the WS_METADATA_PROPERTY structure contains the current WS_METADATA_STATE of the metadata object.

WS_METADATA_PROPERTY_HEAP_PROPERTIES

This property is used with WsCreateMetadata to specify properties of the WS_HEAP object used by the metadata object to store information about the metadata that was read.

The accompanying value member of the WS_METADATA_PROPERTY structure contains a WS_HEAP_PROPERTIES structure.

The following heap properties may be specified:

WS_METADATA_PROPERTY_POLICY_PROPERTIES

This property is used with WsCreateMetadata to specify properties of the WS_POLICY objects that are associated with the metadata object.

The accompanying value member of the WS_METADATA_PROPERTY structure contains a WS_POLICY_PROPERTIES structure that specifies the set of policy properties.

See WS_POLICY_PROPERTY_ID for more information on the set of properties that may be specified here.

WS_METADATA_PROPERTY_HEAP_REQUESTED_SIZE

This property is used with WsGetMetadataProperty.

The accompanying value member of the WS_METADATA_PROPERTY is a SIZE_T specifying the number of bytes allocated from the heap associated with the metadata object.

WS_METADATA_PROPERTY_MAX_DOCUMENTS

This property is used with WsCreateMetadata.

The accompanying value member of the WS_METADATA_PROPERTY is a ULONG specifying the maximum number of documents that may be added to the metadata object using WsReadMetadata.

The default value is 32.

WS_METADATA_PROPERTY_HOST_NAMES

This property is used with WsCreateMetadata.

The accompanying value member of the WS_METADATA_PROPERTY is a WS_HOST_NAMES structure.

This property may only be specified if WS_METADATA_PROPERTY_VERIFY_HOST_NAMES is TRUE.

See WsGetMissingMetadataDocumentAddress for more information on verifying host names.

If the property is not specified, then the list of host names is empty.

WS_METADATA_PROPERTY_VERIFY_HOST_NAMES

This property is used with WsCreateMetadata.

The accompanying value member of the WS_METADATA_PROPERTY is a BOOL that specifies whether or not host names should be verified.

See WsGetMissingMetadataDocumentAddress for more information on verifying host names.

The default value is TRUE.

Setting this value to FALSE may cause an application to use an address returned from WsGetMissingMetadataDocumentAddress that is from a host that it is not willing to accept metadata from.

Requirements

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

WebServices.h

 

 

Community Additions

ADD
Show:
© 2015 Microsoft