_SimpleFindResultInfo::get_JoinOrderFormInfo, put_JoinOrderFormInfo Property [C++]

The JoinOrderFormInfo property is a read/write Boolean that indicates whether the OrderFormHeader table is joined in the results.

Definition

[C++]

Get method:

HRESULT _SimpleFindResultInfo::get_JoinOrderFormInfo(VARIANT_BOOL*JoinOrderFormInfo);

Put method:

HRESULT _SimpleFindResultInfo::put_JoinOrderFormInfo(VARIANT_BOOLJoinOrderFormInfo);

[Visual Basic]

Property JoinOrderFormInfo As Boolean

Parameters

JoinOrderFormInfo[C++]
[in] When putting the property, a VARIANT BOOLEAN that specifies whether the OrderFormHeader table is to be joined with the results. A value of True specifies that the OrderFormHeader table will be joined. A value of False specifies that it will not be joined.
[out, retval] When getting the property, a VARIANT BOOLEAN that indicates whether the OrderFormHeader table is to be joined with the results. A value of True indicates that the OrderFormHeader table will be joined. A value of False indicates that it will not be joined.

[Visual Basic] None.

[C++]

Return Values

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

Error Values

[C++] 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.

[Visual Basic] This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM 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. In particular, the Description property may contain a text description of the error.

Remarks

[C++] The JoinOrderFormInfo parameter contains valid data only if the property is accessed successfully.

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

[C++] Requirements for using this property are listed in SimpleFindResultInfo Object.

[Visual Basic] Requirements for using this property are listed in SimpleFindResultInfo Object.

Share via