The ISkpSelectionSet interface.
More...
List of all members.
Public Member Functions |
HRESULT | Contains ([in] ISkpEntity *pEntity,[out, retval] BOOL *pVal) |
| Determines whether the given entity is in the selection set.
|
Properties |
ISkpEntity | Item ([in] long nIndex) [get] |
| [propget] Get an item in the selection set.
|
long | Count [get] |
| [propget] Get the number of items in the selection set.
|
IUnknown | _NewEnum [get] |
| [propget] Returns an IEnumVARIANT on the selection set.
|
Detailed Description
The ISkpSelectionSet interface.
- Examples:
-
GetEntitesFromEntityProvider.cpp.
Member Function Documentation
HRESULT ISkpSelectionSet::Contains |
( |
[in] ISkpEntity * |
pEntity, |
|
|
[out, retval] BOOL * |
pVal | |
|
) |
| | |
Determines whether the given entity is in the selection set.
- Return values:
-
| pVal | TRUE iff the given entity is in the selection set. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
Property Documentation
IUnknown ISkpSelectionSet::_NewEnum [get] |
[propget] Returns an IEnumVARIANT on the selection set.
This will return an object implementing IEnumVARIANT. Each entry in the IEnumVARIANT will be an ISkpEntity object.
- Return values:
-
| pVal | The IEnumVARIANT interface |
- Returns:
- S_OK : if successful
E_POINTER : if pVal == NULL
E_UNEXPECTED : indicates unexpected internal errors
long ISkpSelectionSet::Count [get] |
[propget] Get the number of items in the selection set.
- Return values:
-
| pVal | The number of entities in the selection set. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpEntity ISkpSelectionSet::Item([in] long nIndex) [get] |
[propget] Get an item in the selection set.
- Parameters:
-
| nIndex | The index of the desired item in the selection set. |
- Return values:
-
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_INVALIDARG : if nIndex < 0 or nIndex >= Count
E_FAIL : internal errors