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

IDSSKeyInfo Interface Reference

List of all members.

Public Member Functions

HRESULT Clear ()
 Reset all properties of this KeyInfo instance to their default values.
HRESULT ColumnCount ([in] Int32 iColumnCount)
 The number of columns that comprise this key.
HRESULT ColumnCount ([out, retval] Int32 *opColumnCount)
 The number of columns that comprise this key.
HRESULT ColumnName ([in] Int32 iIndex,[in] BSTR iColumnName)
 Set the name of the column at the given 1-based index in this key.
HRESULT ColumnName ([in] Int32 iIndex,[out, retval] BSTR *opColumnName)
 Get the name of the column at the given 1-based index in this key.
HRESULT KeyName ([in] BSTR iKeyName)
 The name of the key in the table.
HRESULT KeyName ([out, retval] BSTR *opKeyName)
 The name of the key in the table.
HRESULT KeyType ([in] EnumDSSDBCKeyType iKeyType)
 The type of the key in the table (primary or foreign).
HRESULT KeyType ([out, retval] EnumDSSDBCKeyType *opKeyType)
 The type of the key in the table (primary or foreign).
HRESULT LoadFromXML ([in] IDispatch *ipElement,[in] EnumDSSCatalogFlags iFlags)
 Populate this KeyInfo instance from its XML representation.
HRESULT Populate ([in] IDSSKeyInfo *ipKeyInfo)
 Populate this KeyInfo instance from another.
HRESULT PopulateFromKey ([in] IDSSDBTableKey *ipKey)
 Populate this KeyInfo instance from a IDSSDBTableKey instance.
HRESULT ReferencedColumnName ([in] Int32 iIndex,[in] BSTR iReferencedColumnName)
 Set the name of the column referenced by the column at the given 1-based index in this foreign key.
HRESULT ReferencedColumnName ([in] Int32 iIndex,[out, retval] BSTR *opReferencedColumnName)
 Get the name of the column referenced by the column at the given 1-based index in this foreign key.
HRESULT ReferencedNamespace ([in] BSTR iReferencedNamespace)
 The namespace of the table referenced by this foreign key.
HRESULT ReferencedNamespace ([out, retval] BSTR *opReferencedNamespace)
 The namespace of the table referenced by this foreign key.
HRESULT ReferencedTableName ([in] BSTR iReferencedTableName)
 The name of the table referenced by this foreign key.
HRESULT ReferencedTableName ([out, retval] BSTR *opReferencedTableName)
 The name of the table referenced by this foreign key.
HRESULT SaveToXML ([in] EnumDSSCatalogFlags iFlags,[out] BSTR *opXML)
 Save this KeyInfo instance to XML or JSON depending on the passed in flags.

Member Function Documentation

HRESULT IDSSKeyInfo::Clear (   ) 
 

Reset all properties of this KeyInfo instance to their default values.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ColumnCount (  [in] Int32  iColumnCount  ) 
 

The number of columns that comprise this key.

Parameters:
iColumnCount Number of columns that comprise this key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ColumnCount (  [out, retval] Int32 *  opColumnCount  ) 
 

The number of columns that comprise this key.

Parameters:
opColumnCount Number of columns that comprise this key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ColumnName (  [in] Int32  iIndex,
[in] BSTR  iColumnName
) 
 

Set the name of the column at the given 1-based index in this key.

Parameters:
iIndex Index of the column the name of which the caller wants to set.
iColumnName Name of the column at the given index that comprises this key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ColumnName (  [in] Int32  iIndex,
[out, retval] BSTR *  opColumnName
) 
 

Get the name of the column at the given 1-based index in this key.

Parameters:
iIndex Index of the column the name of which the caller wants to get.
opColumnName Name of the column at the given index that comprises this key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::KeyName (  [in] BSTR  iKeyName  ) 
 

The name of the key in the table.

Parameters:
iKeyName Name of the key in the table.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::KeyName (  [out, retval] BSTR *  opKeyName  ) 
 

The name of the key in the table.

Parameters:
opKeyName Name of the key in the table.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::KeyType (  [in] EnumDSSDBCKeyType  iKeyType  ) 
 

The type of the key in the table (primary or foreign).

Parameters:
iKeyType Type of the key in the table
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::KeyType (  [out, retval] EnumDSSDBCKeyType *  opKeyType  ) 
 

The type of the key in the table (primary or foreign).

Parameters:
opKeyType Type of the key in the table
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::LoadFromXML (  [in] IDispatch *  ipElement,
[in] EnumDSSCatalogFlags  iFlags
) 
 

Populate this KeyInfo instance from its XML representation.

Parameters:
ipElement Pointer to the XML DOM element representing the KeyInfo instance.
iFlags Flags used to control how the KeyInfo instance will be populated from XML.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::Populate (  [in] IDSSKeyInfo *  ipKeyInfo  ) 
 

Populate this KeyInfo instance from another.

Parameters:
ipKeyInfo A KeyInfo instance from which this instance will be populated.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::PopulateFromKey (  [in] IDSSDBTableKey *  ipKey  ) 
 

Populate this KeyInfo instance from a IDSSDBTableKey instance.

Parameters:
ipKey IDSSDBTableKey instance from which this instance will be populated.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ReferencedColumnName (  [in] Int32  iIndex,
[in] BSTR  iReferencedColumnName
) 
 

Set the name of the column referenced by the column at the given 1-based index in this foreign key.

Not used for primary keys.

Parameters:
iIndex Index of the referenced column the name of which the caller wants to set.
iReferencedColumnName Name of the column referenced by the column at the given 1-based index in this foreign key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ReferencedColumnName (  [in] Int32  iIndex,
[out, retval] BSTR *  opReferencedColumnName
) 
 

Get the name of the column referenced by the column at the given 1-based index in this foreign key.

Not used for primary keys.

Parameters:
iIndex Index of the referenced column the name of which the caller wants to get.
opReferencedColumnName Name of the column referenced by the column at the given 1-based index in this foreign key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ReferencedNamespace (  [in] BSTR  iReferencedNamespace  ) 
 

The namespace of the table referenced by this foreign key.

Not used for primary keys.

Parameters:
iReferencedNamespace Namespace of the table referenced by this foreign key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ReferencedNamespace (  [out, retval] BSTR *  opReferencedNamespace  ) 
 

The namespace of the table referenced by this foreign key.

Not used for primary keys.

Parameters:
opReferencedNamespace Namespace of the table referenced by this foreign key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ReferencedTableName (  [in] BSTR  iReferencedTableName  ) 
 

The name of the table referenced by this foreign key.

Not used for primary keys.

Parameters:
iReferencedTableName Name of the table referenced by this foreign key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::ReferencedTableName (  [out, retval] BSTR *  opReferencedTableName  ) 
 

The name of the table referenced by this foreign key.

Not used for primary keys.

Parameters:
opReferencedTableName Name of the table referenced by this foreign key.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSKeyInfo::SaveToXML (  [in] EnumDSSCatalogFlags  iFlags,
[out] BSTR *  opXML
) 
 

Save this KeyInfo instance to XML or JSON depending on the passed in flags.

Parameters:
iFlags Flags used to control if this KeyInfo instance will be serialized to XML or JSON.
opXML XML or JSON representation of this KeyInfo instance.
Returns:
Usual COM result code:
  • S_OK

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