Share via


ClusProperty.Format property

[The Format property is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Returns or sets the format (data type) of a cluster object property.

This property is read-only.

Syntax

ClusProperty.Format

Property value

Long describing the format of the cluster object property. MsClus.h defines the following formats, enumerated in the CLUSTER_PROPERTY_FORMAT enumeration.

CLUSPROP_FORMAT_BINARY (1)

Data is a binary value.

CLUSPROP_FORMAT_DWORD (2)

Data is a DWORD value.

CLUSPROP_FORMAT_EXPAND_SZ (4)

Data is a null-terminated Unicode string with unexpanded references to environment variables.

CLUSPROP_FORMAT_EXPANDED_SZ (8)

Data is a null-terminated Unicode string with expanded references to environment variables.

CLUSPROP_FORMAT_FILETIME (12)

Data is a FILETIME.

CLUSPROP_FORMAT_LARGE_INTEGER (10)

Data is a signed large integer.

CLUSPROP_FORMAT_LONG (7)

Data is an signed long value.

CLUSPROP_FORMAT_MULTI_SZ (5)

Data is an array of null-terminated Unicode strings.

CLUSPROP_FORMAT_SECURITY_DESCRIPTOR (9)

Data is a SECURITY_DESCRIPTOR.

CLUSPROP_FORMAT_SZ (3)

Data is a null-terminated Unicode string.

CLUSPROP_FORMAT_ULARGE_INTEGER (6)

Data is an unsigned large integer.

CLUSPROP_FORMAT_UNKNOWN (0)

Data is in an unknown format.

CLUSPROP_FORMAT_USER (32768)

Data is in a user-defined format.

CLUSPROP_FORMAT_WORD (11)

Data is a WORD value.

Remarks

The Format property corresponds to the wFormat member of a CLUSPROP_SYNTAX union.

For information on making constants defined by the Cluster Automation Server type library (MsClus.tlb) available to scripts, see Creating a Cluster Automation Server Script.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header
MsClus.h
IDL
MsClus.idl
Type library
MsClus.tlb
DLL
MsClus.dll
IID
IID_ISClusProperty is defined as F2E606FE-2631-11D1-89F1-00A0C90D061E

See also

ClusProperty

ClusProperty.Type

CLUSPROP_SYNTAX