Package loci.poi.hpsf

Class Variant

  • Direct Known Subclasses:
    VariantSupport

    public class Variant
    extends Object

    The Variant types as defined by Microsoft's COM. I found this information in http://www.marin.clara.net/COM/variant_type_definitions.htm.

    In the variant types descriptions the following shortcuts are used: [V] - may appear in a VARIANT, [T] - may appear in a TYPEDESC, [P] - may appear in an OLE property set, [S] - may appear in a Safe Array.

    Since:
    2002-02-09
    Version:
    $Id: Variant.java 489730 2006-12-22 19:18:16Z bayard $
    Author:
    Rainer Klute (klute@rainer-klute.de)
    • Field Detail

      • VT_EMPTY

        public static final int VT_EMPTY

        [V][P] Nothing, i.e. not a single byte of data.

        See Also:
        Constant Field Values
      • VT_CY

        public static final int VT_CY

        [V][T][P][S] currency. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_DATE

        public static final int VT_DATE

        [V][T][P][S] date. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_BSTR

        public static final int VT_BSTR

        [V][T][P][S] OLE Automation string. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_DISPATCH

        public static final int VT_DISPATCH

        [V][T][P][S] IDispatch *. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_ERROR

        public static final int VT_ERROR

        [V][T][S] SCODE. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_BOOL

        public static final int VT_BOOL

        [V][T][P][S] True=-1, False=0.

        See Also:
        Constant Field Values
      • VT_VARIANT

        public static final int VT_VARIANT

        [V][T][P][S] VARIANT *. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_UNKNOWN

        public static final int VT_UNKNOWN

        [V][T][S] IUnknown *. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_DECIMAL

        public static final int VT_DECIMAL

        [V][T][S] 16 byte fixed point.

        See Also:
        Constant Field Values
      • VT_HRESULT

        public static final int VT_HRESULT

        [T] Standard return type. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_PTR

        public static final int VT_PTR

        [T] pointer type. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_SAFEARRAY

        public static final int VT_SAFEARRAY

        [T] (use VT_ARRAY in VARIANT).

        See Also:
        Constant Field Values
      • VT_CARRAY

        public static final int VT_CARRAY

        [T] C style array. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_USERDEFINED

        public static final int VT_USERDEFINED

        [T] user defined type. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_LPSTR

        public static final int VT_LPSTR

        [T][P] null terminated string.

        See Also:
        Constant Field Values
      • VT_LPWSTR

        public static final int VT_LPWSTR

        [T][P] wide (Unicode) null terminated string.

        See Also:
        Constant Field Values
      • VT_FILETIME

        public static final int VT_FILETIME

        [P] FILETIME. The FILETIME structure holds a date and time associated with a file. The structure identifies a 64-bit integer specifying the number of 100-nanosecond intervals which have passed since January 1, 1601. This 64-bit value is split into the two dwords stored in the structure.

        See Also:
        Constant Field Values
      • VT_STREAM

        public static final int VT_STREAM

        [P] Name of the stream follows.

        See Also:
        Constant Field Values
      • VT_STORAGE

        public static final int VT_STORAGE

        [P] Name of the storage follows.

        See Also:
        Constant Field Values
      • VT_STREAMED_OBJECT

        public static final int VT_STREAMED_OBJECT

        [P] Stream contains an object. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_STORED_OBJECT

        public static final int VT_STORED_OBJECT

        [P] Storage contains an object. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_BLOB_OBJECT

        public static final int VT_BLOB_OBJECT

        [P] Blob contains an object. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_CF

        public static final int VT_CF

        [P] Clipboard format. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_VECTOR

        public static final int VT_VECTOR

        [P] simple counted array. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_ARRAY

        public static final int VT_ARRAY

        [V] SAFEARRAY*. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_BYREF

        public static final int VT_BYREF

        [V] void* for local use. How long is this? How is it to be interpreted?

        See Also:
        Constant Field Values
      • VT_RESERVED

        public static final int VT_RESERVED

        FIXME (3): Document this!

        See Also:
        Constant Field Values
      • VT_ILLEGAL

        public static final int VT_ILLEGAL

        FIXME (3): Document this!

        See Also:
        Constant Field Values
      • VT_ILLEGALMASKED

        public static final int VT_ILLEGALMASKED

        FIXME (3): Document this!

        See Also:
        Constant Field Values
      • VT_TYPEMASK

        public static final int VT_TYPEMASK

        FIXME (3): Document this!

        See Also:
        Constant Field Values
      • LENGTH_UNKNOWN

        public static final Integer LENGTH_UNKNOWN

        Denotes a variant type with a length that is unknown to HPSF yet.

      • LENGTH_VARIABLE

        public static final Integer LENGTH_VARIABLE

        Denotes a variant type with a variable length.

      • LENGTH_0

        public static final Integer LENGTH_0

        Denotes a variant type with a length of 0 bytes.

      • LENGTH_2

        public static final Integer LENGTH_2

        Denotes a variant type with a length of 2 bytes.

      • LENGTH_4

        public static final Integer LENGTH_4

        Denotes a variant type with a length of 4 bytes.

      • LENGTH_8

        public static final Integer LENGTH_8

        Denotes a variant type with a length of 8 bytes.

    • Constructor Detail

      • Variant

        public Variant()
    • Method Detail

      • getVariantName

        public static String getVariantName​(long variantType)

        Returns the variant type name associated with a variant type number.

        Parameters:
        variantType - The variant type number
        Returns:
        The variant type name or the string "unknown variant type"
      • getVariantLength

        public static int getVariantLength​(long variantType)

        Returns a variant type's length.

        Parameters:
        variantType - The variant type number
        Returns:
        The length of the variant type's data in bytes. If the length is variable, i.e. the length of a string, -1 is returned. If HPSF does not know the length, -2 is returned. The latter usually indicates an unsupported variant type.