All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOCESInterfaces Interface ENOVICESState
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVICESState
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVICESState
Interface representing CES State.
Role: ENOVICESState gives state information which can be used to retreive the ItemSet. This is especially
used for pagination(Getting next set of results).This is always used with context to a CES Search.This is populated and returned as an output parameter in every search call.
- Example:
- ENOVICESState_var oStateObject;
if(partselection!=NULL)// partselection is an interface pointer to ENOVIPartSelection
{
HRESULT myhr=partselection->GetSimpleSearchResults(oResults,oStateObject);
}
- See also:
- ENOVIPartSelection
Method Index
- o
GetComponentID(CATUnicodeString&)
- Retrieve the ComponentID for which the ENOVICESState is created.
- o
GetCurrentPageNo(int&)
- Retrieve the CurrentPageNo for which the ENOVICESState is created.
- o
GetPageID(CATUnicodeString&)
- Retrieve the PageID for which the ENOVICESState is created.
- o
GetStateID(CATUnicodeString&)
- Retrieve the StateID for which the ENOVICESState is created.
Methods
o GetComponentID
-
Retrieve the ComponentID for which the ENOVICESState is created.
- Parameters:
-
- oComponentID
- This is an ouput parameter which contains ComponentID if method call is successful.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Retrival of value is successful
- E_FAIL
- Retrival of value is not successful
o GetCurrentPageNo
public virtual HRESULT GetCurrentPageNo( | int& | opage_no)=0 |
-
Retrieve the CurrentPageNo for which the ENOVICESState is created.
- Parameters:
-
- opage_no
- This is an ouput parameter which contains CurrentPageNo if method call is successful.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Retrival of value is successful
- E_FAIL
- Retrival of value is not successful
o GetPageID
-
Retrieve the PageID for which the ENOVICESState is created.
- Parameters:
-
- oPageID
- This is an ouput parameter which contains PageID if method call is successful.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Retrival of value is successful
- E_FAIL
- Retrival of value is not successful
o GetStateID
-
Retrieve the StateID for which the ENOVICESState is created.
- Parameters:
-
- oStateID
- This is an ouput parameter which contains StatedID if method call is successful.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Retrival of value is successful
- E_FAIL
- Retrival of value is not successful
This object is included in the file: ENOVICESState.h
If needed, your Imakefile.mk should include the module: ENOVCESPartSelectionApi