The mutable, or editable, version of the ISkpNamedValues interface.
More...
List of all members.
Public Member Functions |
HRESULT | Set ([in] BSTR valueName,[in]VARIANT value) |
| Sets the name to have the given value. Replaces if current, adds if new.
|
Properties |
long | Count [get] |
| [propget] The number of entities in this collection
|
IUnknown | _NewEnum [get] |
| [propget] Gets an IEnumVARIANT from the collection
|
ISkpNamedValue | Item ([in] long nIndex) [get] |
| [propget] Gets the ith item from the collection
|
VARIANT | Value ([in] BSTR valueName) [get] |
| [propget] Gets the value of the item in the collection with the given name.
|
Detailed Description
The mutable, or editable, version of the ISkpNamedValues interface.
This interface is currently only supported by a limited number of ISkpNamedValues coclasses. In particular, see ISkpHLRGeneration and the Options method.
Member Function Documentation
HRESULT ISkpNamedValuesM::Set |
( |
[in] BSTR |
valueName, |
|
|
[in] VARIANT |
value | |
|
) |
| | |
Sets the name to have the given value. Replaces if current, adds if new.
This method allows one to update or add to the collection.
If the given name is found in the collection, the value of the matching element is updated. This match is restricted to the 1st matching element.
- Parameters:
-
| valueName | The name of the item to match |
| value | The value to use |
- Returns:
- S_OK : if successful
E_UNEXPECTED : indicates unexpected internal errors
Property Documentation
IUnknown ISkpNamedValuesM::_NewEnum [get] |
[propget] Gets an IEnumVARIANT from the collection
- Return values:
-
| pVal | The IEnumVARIANT interface |
- Returns:
- S_OK : if successful
E_POINTER : if pVal == NULL
E_UNEXPECTED : indicates unexpected internal errors
long ISkpNamedValuesM::Count [get] |
[propget] The number of entities in this collection
- Return values:
-
- Returns:
- S_OK : if successful
E_POINTER : if pVal == NULL
[propget] Gets the ith item from the collection
- Parameters:
-
| nIndex | the 0-based index of the desired item. |
- Return values:
-
- Returns:
- S_OK : if successful
E_POINTER : if pVal == NULL
E_UNEXPECTED : indicates unexpected internal errors
E_INVALIDARG : nIndex is < 0 or > Count of this collection.
VARIANT ISkpNamedValuesM::Value([in] BSTR valueName) [get] |
[propget] Gets the value of the item in the collection with the given name.
If more than one item exist in the collection with the same name, the first item found is returned. There is no guarantee as to the order of the items in the collection.
- Parameters:
-
| valueName | The name of the desired element |
- Return values:
-
| pVal | The value of the item with the given name |
- Returns:
- S_OK : if successful
E_POINTER : if pVal == NULL
E_UNEXPECTED : indicates unexpected internal errors
E_INVALIDARG : there is no matching item in the collection with the given name