ISpecifyPropertyPages::GetPages method (ocidl.h)

Retrieves a list of property pages that can be displayed in this object's property sheet.

Syntax

HRESULT GetPages(
  [out] CAUUID *pPages
);

Parameters

[out] pPages

A pointer to a caller-allocated CAUUID structure that must be initialized and filled before returning. The pElems member in the structure is allocated by the callee with CoTaskMemAlloc and freed by the caller with CoTaskMemFree.

Return value

This method can return the standard return values E_OUTOFMEMORY and E_UNEXPECTED, as well as the following values.

Return code Description
S_OK
The method completed successfully.
E_POINTER
The address in pPages is not valid. For example, it may be NULL.

Remarks

The CAUUID structure is caller-allocated, but is not initialized by the caller. The GetPages method fills the cElements member in the structure. This method also allocates memory for the array pointed to by the pElems member using CoTaskMemAlloc. Then, it fills the newly allocated array. After this method returns successfully, the structure contains a counted array of UUIDs, each UUID specifying a property page CLSID.

Notes to Callers

The caller must release the memory pointed to by the pElems member of CAUUID, using CoTaskMemFree when it is no longer needed.

Notes to Implementers

E_NOTIMPL is not allowed as a return value, because an object with no property pages should not expose the ISpecifyPropertyPages interface.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ocidl.h

See also

ISpecifyPropertyPages