IFrameArray Interface
- GetCount
- SetCount
- GetFrame
- SetFrame
- InsertAt
- Add
- RemoveAt
- RemoveAll
Gives access to an array of frames
See also Interface List
[propget] HRESULT GetCount(int * count)
Parameters
count - [out, retval] the returned
size of the array
- Remarks:
Returns size of the array. This method is a get method for Count property of
the array
[propput] HRESULT SetCount(int count)
Parameters
count - [in] new size of the array
- Remarks:
Changes size of the array. Stored elements are preserved where possible. This
method is the set method of Count property of the array
[propget] HRESULT GetFrame(int index, IFrame** frame)
Parameters
index - [in] 0-based index into the array
frame - [out, retval] The returned index-th
frame
Return Values
- S_OK in case of
success.
DISP_E_BADINDEX if the index was out of range
- Remarks:
The method returns the index-th frame stored in the
array.
[propput] HRESULT SetFrame(int index, IFrame* frame)
Parameters
index - [in] 0-based index into the array
frame - [in] new value of the the index-th
element
Return Values
- S_OK in case of
success.
DISP_E_BADINDEX if the index was out of range
- Remarks:
Sets the index-th frame
HRESULT InsertAt(int index, IFrame* frame)
Parameters
index - [in] 0-based index into the array
frame - [in] new value of the the index-th
element
Return Values
- S_OK in case of
success.
DISP_E_BADINDEX if the index was out of range
- Remarks:
The method inserts frame at the specified index.
Elements after are shifted up.
HRESULT Add(IFrame* frame)
Parameters
frame - [in] the number to be added
- Remarks:
The method adds frame at the end of the array
HRESULT RemoveAt(int index)
Parameters
index - [in] 0-based index into the array
Return Values
- S_OK in case of
success.
DISP_E_BADINDEX if the index was out of range
- Remarks:
The method removes element at the specified index. Elements after are shifted
down.
HRESULT RemoveAll()
- Remarks:
The method empties the array. It is equivalent to SetCout(0).
|