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

IDSSFunctionPackageDefinition Interface Reference

List of all members.

Detailed Description

This interface specifies a plug-in function software package.

This interface is the type-specific interface of a first class object. The interface duplicates information available from the ICDSSFunctionPackage interface. It enables a user to store information about function packages in metadata. In particular it is not necessary for a function package to be installed on a client machine for a user to create expressions involving functions from the package.


Public Member Functions

HRESULT ClassID ([in] BSTR CLSID)
 The Class ID of the COM Object that implements this package.
HRESULT ClassID ([out, retval] BSTR *pCLSID)
 The Class ID of the COM Object that implements this package.
HRESULT Functions ([out, retval] IDSSFunctions ppFunctions)
 Collection of functions supported in the package.
HRESULT Info ([out, retval] IDSSObjectInfo ppInfo)
 The name, description etc.
HRESULT PackageVersion ([in] BSTR Version)
 User supplied version string.
HRESULT PackageVersion ([out, retval] BSTR *pVersion)
 User supplied version string.
HRESULT ProgID ([in] BSTR ProgID)
 The programmatic name of the COM Object.
HRESULT ProgID ([out, retval] BSTR *pProgID)
 The programmatic name of the COM Object.


Member Function Documentation

HRESULT IDSSFunctionPackageDefinition::ClassID [in] BSTR  CLSID  ) 
 

The Class ID of the COM Object that implements this package.

ClassID is a read/write string valued property. It is the CLSID that the function server should use to obtain the COM object that implements the function package. This number is a GUID - a 32 digit hexadecimal number.

Parameters:
CLSID New value for CLSID. May be NULL.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSFunctionPackageDefinition::ClassID [out, retval] BSTR *  pCLSID  ) 
 

The Class ID of the COM Object that implements this package.

ClassID is a read/write string valued property. It is the CLSID that the function server should use to obtain the COM object that implements the function package. This number is a GUID - a 32 digit hexadecimal number.

Parameters:
pCLSID Old value for CLSID. Could be NULL.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSFunctionPackageDefinition::Functions [out, retval] IDSSFunctions   ppFunctions  ) 
 

Collection of functions supported in the package.

The Functions property is a read-only collection interface. It contains the list of functions supported by this package. These functions are also DSS Objects that are separately stored in the metadata.

Internally this is implemented by storing a list of DSS_IDs in the function package definition object.
Parameters:
ppFunctions Collection of all the functions. Never NULL.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSFunctionPackageDefinition::Info [out, retval] IDSSObjectInfo   ppInfo  ) 
 

The name, description etc.

of this package.. Info is the standard IDSSObjectInfo property of a first class object. It contains the ID, Name and description of the software package. It is used to load, and save the information about the package into metadata.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSFunctionPackageDefinition::PackageVersion [in] BSTR  Version  ) 
 

User supplied version string.

This is a string that describes the version of the function package. It is not a GUID, but instead is a vendor specific string. We expect it to say something like 1.2.1 or the like.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSFunctionPackageDefinition::PackageVersion [out, retval] BSTR *  pVersion  ) 
 

User supplied version string.

This is a string that describes the version of the function package. It is not a GUID, but instead is a vendor specific string. We expect it to say something like 1.2.1 or the like.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSFunctionPackageDefinition::ProgID [in] BSTR  ProgID  ) 
 

The programmatic name of the COM Object.

ProgID is a read/write string property. The ProgID of a COM Object is a human readable string (typically something like DSSCOM.StandardFunctionPackage.1) that can be searched for in the registry in order to find the CLSID. It allows a human to add a new function package definition, without ever having to type in the CLSID directly. However it is not guaranteed to be unique.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSFunctionPackageDefinition::ProgID [out, retval] BSTR *  pProgID  ) 
 

The programmatic name of the COM Object.

ProgID is a read/write string property. The ProgID of a COM Object is a human readable string (typically something like DSSCOM.StandardFunctionPackage.1) that can be searched for in the registry in order to find the CLSID. It allows a human to add a new function package definition, without ever having to type in the CLSID directly. However it is not guaranteed to be unique.

Returns:
Usual COM result code:
  • S_OK


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