IDSSElementReplacementMap Interface Reference

List of all members.

Public Member Functions
HRESULT	AddByIndex ([in] Int32 iIndex,[in] BSTR iAttributeID,[in, optional] BSTR iElementKeys,[in, optional, defaultvalue(-2)] Int32 iReplacementBaseFormID,[in, optional] BSTR iReplacementBaseFormValue)
	Add the element info for the elements search or replace.
HRESULT	ClearAll ()
	Clear all the elements info.
HRESULT	Count ([out, retval] Int32 *opCount)
	Get the count of the elements info.
HRESULT	ItemByIndex ([in] Int32 iIndex,[out] BSTR *opAttributeID,[out] BSTR *opElementKeys,[out] Int32 *opReplacementBaseFormID,[out] BSTR *opReplacementBaseFormValue)
	Get the element info by index.
HRESULT	RemoveByIndex ([in] Int32 iIndex)
	Remove the element info by index.
HRESULT	ReplaceByIndex ([in] Int32 iIndex,[in, optional] BSTR iAttributeID,[in, optional] BSTR iElementKeys,[in, optional, defaultvalue(-2)] Int32 iReplacementBaseFormID,[in, optional] BSTR iReplacementBaseFormValue)
	Modify the element info by index.

---

Member Function Documentation

HRESULT IDSSElementReplacementMap::AddByIndex (  [in] Int32  iIndex, [in] BSTR  iAttributeID, [in, optional] BSTR  iElementKeys, [in, optional, defaultvalue(-2)] Int32  iReplacementBaseFormID, [in, optional] BSTR  iReplacementBaseFormValue )

Add the element info for the elements search or replace. Parameters: iIndex  The position where we want to insert this element info, if the iIndex equals to -1, we will add it in the end. iAttributeID  The users can specify the attribute's id for visiting concrete elements which refer to this attribute. iElementKeys  Optional for the element search. The user can specify the matched element value. iReplacementBaseFormID  Only for the element replace. The users need to specify the base_form_id that they want to change. iReplacementBaseFormValue  Only for the element replace. The users need to specify the base_form_value that they want to change. Returns: Usual COM result code: S_OK

HRESULT IDSSElementReplacementMap::ClearAll (   )

Clear all the elements info. Returns: Usual COM result code: S_OK

HRESULT IDSSElementReplacementMap::Count (  [out, retval] Int32 *  opCount  )

Get the count of the elements info. Parameters: opCount  The count of elements. Returns: Usual COM result code: S_OK

HRESULT IDSSElementReplacementMap::ItemByIndex (  [in] Int32  iIndex, [out] BSTR *  opAttributeID, [out] BSTR *  opElementKeys, [out] Int32 *  opReplacementBaseFormID, [out] BSTR *  opReplacementBaseFormValue )

Get the element info by index. Parameters: iIndex  The input index. opAttributeID  The current element-replacement info: Attribute_ID. opElementKeys  The current element-replacement info: Matched_Key_Value. opReplacementBaseFormID  Optional, the current element-replacement info: Replacement_BaseFormID. opReplacementBaseFormValue  Optional, the current element-replacement info: Replacement_BaseFormValue. Returns: Usual COM result code: S_OK

HRESULT IDSSElementReplacementMap::RemoveByIndex (  [in] Int32  iIndex  )

Remove the element info by index. Parameters: iIndex  The input index. Returns: Usual COM result code: S_OK

HRESULT IDSSElementReplacementMap::ReplaceByIndex (  [in] Int32  iIndex, [in, optional] BSTR  iAttributeID, [in, optional] BSTR  iElementKeys, [in, optional, defaultvalue(-2)] Int32  iReplacementBaseFormID, [in, optional] BSTR  iReplacementBaseFormValue )

Modify the element info by index. Parameters: iIndex  The position of the existing elements that we want to modify. iAttributeID  The users can change the attribute's id iElementKeys  The user can specify the matched element value. iReplacementBaseFormID  Only for the element replace. The users can change the element replacement info: base_form_id(should be large or equal to -2). iReplacementBaseFormValue  Only for the element replace. The users can change the element replacement info: base_form_value. Returns: Usual COM result code: S_OK

---