_OrderGroupManager::FindTemplatesForUser

Article
06/07/2013

Ee797930.vb_on(en-US,CS.10).gif

Use this method to build and return an ADO recordset of OrderGroup templates for the specified user.

Definition

HRESULT _OrderGroupManager::FindTemplatesForUser(BSTRUserId,VARIANTSearchDateTimeColumn,VARIANTSearchDateTimeStart,VARIANTSearchDateTimeEnd,VARIANT_BOOLJoinOrderFormInfo,VARIANT_BOOLJoinLineItemInfo,VARIANTColumns,VARIANTOrderGroupSortColumn,VARIANTSortDirection,longPageSize,longPageNumber,VARIANT*outTotalRecordsFound,VARIANT*pvtRetVal);

Parameters

UserId

[in] A BSTR that contains the User ID GUID.

SearchDateTimeColumn

[in, optional] A VARIANT that contains the DateTime column name to use in the search.

SearchDateTimeStart

[in, optional] A VARIANT that contains the search DateTime start value.

SearchDateTimeEnd

[in, optional] A VARIANT that contains the search DateTime end value.

JoinOrderFormInfo

[in, optional, defaultvalue (0)] A VARIANT_BOOL that indicates whether the OrderFormHeader table is included in the search. A value of True indicates that the table is included. A value of False indicates that the table is not included.

JoinLineItemInfo

[in, optional, defaultvalue (0)] A VARIANT_BOOL that indicates whether the OrderFormLineItem table is included in the search. A value of True indicates that the table is included. A value of False indicates that the table is not included.

Columns

[in, optional] A VARIANT that contains the names of columns that you want returned in addition to the default columns.

OrderGroupSortColumn

[in, optional] A VARIANT that contains the OrderGroup sort column.

SortDirection

[in, optional] A VARIANT that contains the sort direction.

PageSize

[in, optional, defaultvalue (20)] A long that contains the page size.

PageNumber

[in, optional, defaultvalue (1)] A long that contains the page number.

outTotalRecordsFound

[out, optional] A pointer to the VARIANT that contains the total number of records found.

pvtRetVal

[out, retval] A pointer to a VARIANT used to return an ADO recordset of the search results.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

This method returns 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 pvtRetVal and outTotalRecordsFound parameters point to valid data only if the method returns successfully.

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