IDSSGenericData Interface Reference

List of all members.

---

Detailed Description

Interface supported by all DSS Objects to expose generic features like iteration of multilingual strings.

Public Member Functions
HRESULT	IterateMultilingualStrings ([in] IDSSVisitMultilingualString *ipVisitor,[in] EnumDSSMultilingualStringQualities iQualities,[in, defaultvalue(0)] IDSSCollection *opExtraIteratedObjects)
	Iterate over the multilingual strings in the object and, depending on the iQualities flag, any managed first class objects(MFCO) that this object refers to (let's call them 'extra objects').
HRESULT	MultilingualString ([in] BSTR iKey,[out, retval] IDSSMultilingualString oppMultilingualString)
	Retrieve the multilingual string corresponding to the given key.

---

Member Function Documentation

HRESULT IDSSGenericData::IterateMultilingualStrings (  [in] IDSSVisitMultilingualString *  ipVisitor, [in] EnumDSSMultilingualStringQualities  iQualities, [in, defaultvalue(0)] IDSSCollection *  opExtraIteratedObjects )

Iterate over the multilingual strings in the object and, depending on the iQualities flag, any managed first class objects(MFCO) that this object refers to (let's call them 'extra objects'). The object calls the visitor interface for each multilingual string from the object and refered MFCO (if corresponding iQualities flag is set). The method is guaranteed to report each multilingual string exactly once. The iQualities parameter allows the caller to specify which class of multilingual strings to iterate over. By default the method will iterate over all multilingual strings in all parts of the object on which this method is called. Parameters: ipVisitor  The interface that should be called for each multilingual string. This parameter must not be NULL on entry. iQualities  Flags from the EnumDSSMultilingualStringQualities enumeration specifying which class of multilingual strings to iterate over. opExtraIteratedObjects  Optional. Collection to get a set of 'extra objects' that are involved in this call. If the caller passes in NULL, we don't populate the collection of course. Returns: COM result code. This result code is S_OK, or an error code returned to the iterator by the visitor interface.

HRESULT IDSSGenericData::MultilingualString (  [in] BSTR  iKey, [out, retval] IDSSMultilingualString   oppMultilingualString )

Retrieve the multilingual string corresponding to the given key. Parameters: iKey  The string key uniquely identifying the location of any multilingual string inside an object. oppMultilingualString  The string corresponding to the given key. Returns: COM result code. S_OK DSSCOM_E_INVALID_MULTILINGUAL_STRING_KEY The passed in key does not correspond to a multilingual string.

---