_SimpleFindResultInfo::get_PageNumber, put_PageNumber

Ee797790.c++_off(en-US,CS.10).gifEe797790.vb_on(en-US,CS.10).gif

The PageNumber property is a read/write Long that contains the page number to jump to. This property setting must be coordinated with the PageSize property.

Definition

Get method:

HRESULT _SimpleFindResultInfo::get_PageNumber(long*PageNumber);

Put method:

HRESULT _SimpleFindResultInfo::put_PageNumber(longPageNumber);

Parameters

PageNumber

[in] When putting the property, a long that contains the page number.
[out, retval] When getting the property, a long used to return the page number.

Return Values

These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.

Error Values

These methods return S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

Remarks

The PageNumber parameter contains valid data only if the property is accessed successfully.

Use this property to implement a paging mechanism that allows you to page through your orders. (These orders could be viewed in a List Sheet, for example.)

This property is initialized to 1.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Requirements for using this property are listed in SimpleFindResultInfo Object.

See Also

SimpleFindResultInfo Object


All rights reserved.