Go to Google Code Home
Google SketchUp SkpReader C++ API Documentation (Labs)

Public Member Functions | Properties

ISkpPages Interface Reference

A collection of pages. More...

List of all members.

Public Member Functions

HRESULT GetPageWithName ([in] BSTR name,[out] ISkpPage **pVal)
 Get a Page with a given name.

Properties

long Count [get]
 The number of entities in this collection.
ISkpPage Item ([in] long Index) [get]
 return the Indexth item in the collection.
IUnknown _NewEnum [get]
 Gets an IEnumVARIANT from the collection.
ISkpPage SelectedPage [get]
 Get the selected Page.

Detailed Description

A collection of pages.


Member Function Documentation

HRESULT ISkpPages::GetPageWithName ( [in] BSTR  name,
[out] ISkpPage **  pVal 
)

Get a Page with a given name.

Parameters:
name the name of the Page to get
pVal The non-NULL return value into which to place the item.
Returns:
S_OK : if successful
E_INVALIDARG : if there is no Page with the given name.
E_POINTER : if pVal is NULL.
E_FAIL: Internal errors.

Property Documentation

IUnknown ISkpPages::_NewEnum [get]

Gets an IEnumVARIANT from the collection.

This will return an object implementing IEnumVARIANT. Each entry in the IEnumVARIANT will be an ISkpPage object.

Return values:
pVal The IEnumVARIANT interface
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
E_UNEXPECTED : indicates unexpected internal errors
long ISkpPages::Count [get]

The number of entities in this collection.

Return values:
pVal the number of entities in this collection
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpPage ISkpPages::Item([in] long Index) [get]

return the Indexth item in the collection.

Parameters:
Index The 0-based index of the item to return.
pVal The non-NULL return value into which to place the item.
Returns:
S_OK : if successful
E_INVALIDARG : if Index < 0 or >= the size of the collection.
E_POINTER : if pVal is NULL.
E_FAIL: Internal errors.
ISkpPage ISkpPages::SelectedPage [get]

Get the selected Page.

Parameters:
pVal The non-NULL return value into which to place the item.
Returns:
S_OK : if successful
E_POINTER : if pVal is NULL.
E_FAIL: Internal errors.

©2010 Google - Google Home - About Google