Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSDataType Interface Reference

List of all members.

Detailed Description

The interface IDSSDataType is used to describe a MicroStrategy internal data type.

It supports properties which are used to describe the type of data that can be used for internal processing.


Public Member Functions

HRESULT BitLength ([out, retval] Int32 *pBitLength)
 The length of the internal type in terms of bits (not supported by all types).
HRESULT BitLength ([in] Int32 BitLength)
 The length of the internal type in terms of bits (not supported by all types).
HRESULT ByteLength ([out, retval] Int32 *pByteLength)
 The length of the internal type in terms of bytes (not supported by all types).
HRESULT ByteLength ([in] Int32 ByteLength)
 The length of the internal type in terms of bytes (not supported by all types).
HRESULT DecimalScale ([out, retval] Int32 *pScale)
 The number of decimal digits after the decimal point for the internal type (not supported by all types).
HRESULT DecimalScale ([in] Int32 Scale)
 The number of decimal digits after the decimal point for the internal type (not supported by all types).
HRESULT get_DataType ([out] EnumDSSDataType *pType,[out] Int32 *pPrecision,[out] Int32 *pScale)
 Retrieve internal data member values of DSSDataType objects.
HRESULT Precision ([out, retval] Int32 *pPrecision)
 The number of decimal digits of the internal type (not supported by all types).
HRESULT Precision ([in] Int32 Precision)
 The number of decimal digits of the internal type (not supported by all types).
HRESULT put_DataType ([in] EnumDSSDataType Type,[in] Int32 Precision,[in] Int32 Scale)
 Change internal data members values of DSSDataType objects.
HRESULT TimeScale ([out, retval] Int32 *pTimeScale)
 The number of digits for the fraction of seconds in time data types.
HRESULT TimeScale ([in] Int32 TimeScale)
 The number of digits for the fraction of seconds in time data types.
HRESULT Type ([out, retval] EnumDSSDataType *pType)
 DSS internal data type, using enumeration EnumDSSDataType.
HRESULT Type ([in] EnumDSSDataType Type)
 DSS internal data type, using enumeration EnumDSSDataType.

Member Function Documentation

HRESULT IDSSDataType::BitLength (  [out, retval] Int32 *  pBitLength  ) 
 

The length of the internal type in terms of bits (not supported by all types).

This property gives the number of binary digits used to hold a specific DSSDataType. DssDataTypeFloat currently supports this property.

Parameters:
pBitLength The number of bits
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::BitLength (  [in] Int32  BitLength  ) 
 

The length of the internal type in terms of bits (not supported by all types).

This property gives the number of binary digits used to hold a specific DSSDataType. DssDataTypeFloat currently supports this property.

Parameters:
BitLength The number of bits
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::ByteLength (  [out, retval] Int32 *  pByteLength  ) 
 

The length of the internal type in terms of bytes (not supported by all types).

This property gives the number of binary digits used to hold a specific DSSDataType. This property is currently supported by DssDataTypeInteger, DssDataTypeUnsigned, DssDataTypeChar, DssDataTypeVarChar, DssDataTypeLongVarChar, DssDataTypeBinary, DssDataTypeVarBin and DssDataTypeLongVarBin.

Parameters:
pByteLength The number of bytes
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::ByteLength (  [in] Int32  ByteLength  ) 
 

The length of the internal type in terms of bytes (not supported by all types).

This property gives the number of binary digits used to hold a specific DSSDataType. This property is currently supported by DssDataTypeInteger, DssDataTypeUnsigned, DssDataTypeChar, DssDataTypeVarChar, DssDataTypeLongVarChar, DssDataTypeBinary, DssDataTypeVarBin and DssDataTypeLongVarBin.

Parameters:
ByteLength The number of bytes
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::DecimalScale (  [out, retval] Int32 *  pScale  ) 
 

The number of decimal digits after the decimal point for the internal type (not supported by all types).

This property gives the number of digits after decimal point for a particular data types. DssDataTypeNumeric and DssDataTypeDecimal currently support this property.

Parameters:
pScale The number of digits after decimal point
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::DecimalScale (  [in] Int32  Scale  ) 
 

The number of decimal digits after the decimal point for the internal type (not supported by all types).

This property gives the number of digits after decimal point for a particular data types. DssDataTypeNumeric and DssDataTypeDecimal currently support this property.

Parameters:
Scale The number of digits after decimal point
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::get_DataType (  [out] EnumDSSDataType *  pType,
[out] Int32 *  pPrecision,
[out] Int32 *  pScale
) 
 

Retrieve internal data member values of DSSDataType objects.

Obtain all three internal data members of DSSDataType object directly, disregarding the data type. User of this method must correctly interpret the meaning of Precision and Scale, which are totally dependent on the Type. In order to avoid misuse of this method, it is marked as restricted so that it does not appear in VB object browser.

Parameters:
pType DSS internal data type, using enumeration EnumDSSDataType.
pPrecision Precision data member of DSSDataType.
pScale Scale data member of DSSDataType .
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDataType::Precision (  [out, retval] Int32 *  pPrecision  ) 
 

The number of decimal digits of the internal type (not supported by all types).

This property gives the number of decimal digits for a particular data types. DssDataTypeNumeric and DssDataTypeDecimal currently support this property.

Parameters:
pPrecision The number of decimal digits
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::Precision (  [in] Int32  Precision  ) 
 

The number of decimal digits of the internal type (not supported by all types).

This property gives the number of decimal digits for a particular data types. DssDataTypeNumeric and DssDataTypeDecimal currently support this property.

Parameters:
Precision The number of decimal digits
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::put_DataType (  [in] EnumDSSDataType  Type,
[in] Int32  Precision,
[in] Int32  Scale
) 
 

Change internal data members values of DSSDataType objects.

Assign all three internal data members of DSSDataType object directly, disregarding the data type. User of this method must know exactly the meaning of Precision and Scale, which are totally dependent on the Type. In order to avoid misuse of this method, it is marked as restricted so that it does not appear in VB object browser.

Parameters:
Type DSS internal data type, using enumeration EnumDSSDataType.
Precision Precision data member of DSSDataType
Scale Scale data member of DSSDataType
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDataType::TimeScale (  [out, retval] Int32 *  pTimeScale  ) 
 

The number of digits for the fraction of seconds in time data types.

This property gives the number of digits after the second's decimal point. DssDataTypeTime and DssDataTypeTimeStamp currently support this property.

Parameters:
pTimeScale The number of digits after the second's decimal point
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::TimeScale (  [in] Int32  TimeScale  ) 
 

The number of digits for the fraction of seconds in time data types.

This property gives the number of digits after the second's decimal point. DssDataTypeTime and DssDataTypeTimeStamp currently support this property.

Parameters:
TimeScale The number of digits after the second's decimal point
Returns:
Usual COM result code:
  • S_OK Success
  • S_FALSE This particular data type does not support this property

HRESULT IDSSDataType::Type (  [out, retval] EnumDSSDataType *  pType  ) 
 

DSS internal data type, using enumeration EnumDSSDataType.

The enumeration EnumDSSDataType used has the following values:
Constant Value Comment
DssDataTypeReserved 0 unknown datatype
DssDataTypeInteger 1 signed integer
DssDataTypeUnsigned 2 unsigned integer
DssDataTypeNumeric 3 number with exact precision and scale
DssDataTypeDecimal 4 similar to DssDataTypeNumeric , actual precision may be larger
DssDataTypeReal 5 single precision real number, 4 bytes
DssDataTypeDouble 6 double precision real number, 8 bytes
DssDataTypeFloat 7 floating point number with precision
DssDataTypeChar 8 fixed length character string
DssDataTypeVarChar 9 variable length character string
DssDataTypeLongVarChar 10 variable length char data up to 2GB
DssDataTypeBinary 11 fixed length binary data
DssDataTypeVarBin 12 variable length binary data
DssDataTypeLongVarBin 13 variable length binary data, up to 2GB
DssDataTypeDate 14 date: containing year, month and day
DssDataTypeTime 15 time: hour, minute, second and fraction of second
DssDataTypeTimeStamp 16 include both data and time.
Parameters:
pType DSS internal data type, using enumeration EnumDSSDataType.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDataType::Type (  [in] EnumDSSDataType  Type  ) 
 

DSS internal data type, using enumeration EnumDSSDataType.

The enumeration EnumDSSDataType used has the following values:
Constant Value Comment
DssDataTypeReserved 0 unknown datatype
DssDataTypeInteger 1 signed integer
DssDataTypeUnsigned 2 unsigned integer
DssDataTypeNumeric 3 number with exact precision and scale
DssDataTypeDecimal 4 similar to DssDataTypeNumeric , actual precision may be larger
DssDataTypeReal 5 single precision real number, 4 bytes
DssDataTypeDouble 6 double precision real number, 8 bytes
DssDataTypeFloat 7 floating point number with precision
DssDataTypeChar 8 fixed length character string
DssDataTypeVarChar 9 variable length character string
DssDataTypeLongVarChar 10 variable length char data up to 2GB
DssDataTypeBinary 11 fixed length binary data
DssDataTypeVarBin 12 variable length binary data
DssDataTypeLongVarBin 13 variable length binary data, up to 2GB
DssDataTypeDate 14 date: containing year, month and day
DssDataTypeTime 15 time: hour, minute, second and fraction of second
DssDataTypeTimeStamp 16 include both data and time.
Parameters:
Type DSS internal data type, using enumeration EnumDSSDataType.
Returns:
Usual COM result code:
  • S_OK

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.