How to work with the ContentDropper APIs.
- See Also
- IContentDropperFacade
- IContentDropperAppData
- IContentDropperDocData
- CCollection
| ErrorCode SnpContentDropper::ExpandOrCollapseHead | ( | const bool16 | expand | ) | |
Expand or collapse the collection at the head of the conveyor.
- Parameters
| expand | kTrue to expand the head item, kFalse to collapse it. |
- Return values
| kSuccess | if successful. |
| kFailure | if the head of the conveyor cannot be expanded. |
| ErrorCode SnpContentDropper::Inspect | ( | | ) | |
Inspects the contents of the content dropper.
Iterates over the collections on the content dropper, tracing information about the collections and their contents to the SnippetRunner log. Additionally reports information about the current item at the head of the content dropper.
- Return values
| kSuccess | on success |
| kFailure | otherwise |
| ErrorCode SnpContentDropper::InspectDocumentContributions | ( | | ) | |
Examine the collections on the conveyor from each open document.
For each open document, inspect the collections added to the document by the given document.
- Return values
| ErrorCode SnpContentDropper::LoadSelectionIntoDropper | ( | const UIDList & | items | ) | |
Loads the selected items onto the content dropper's conveyor.
- Parameters
| [in] | items | The items to load onto the conveyor |
- Returns
- ErrorCode returned when loading the conveyor.
| ErrorCode SnpContentDropper::RotateContentDropper | ( | const int32 | byHowMany, |
| | const bool16 | isForward |
| ) | | |
Rotate the items on the content dropper.
- Parameters
| byHowMany | How many items do you want to rotate by? |
| isForward | kTrue to rotate forwards, kFalse otherwise |
- Return values
| kSuccess | if rotation is successful |
| kFailure | otherwise |