Sumex1.net/miscValidator/C++ API: IValidate::MoveFirst method

API browser of miscValidator200 COM module

IValidate::MoveFirst method
Moves the record pointer to the first record in the selection list and makes that record the current record. All property functions act upon and return data from that current record If the action could not be performed or the selection list is empty than S_FALSE will be returned.

Restful webservice calling syntax
[POST]	/baseURL/IValidate/MoveFirst
[JSON input data]	pIValidate: bstrTariffType:	longValue, //interface address "utf8StringValue"
[JSON result data]	pbStatus:	booleanValue
[HTTP result status]	200	Return status 200 signals a successful method call
	204	Return status 204 (noContent) signals that the end of an iteration is reached
	>= 400	Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.

C/C++ calling syntax
HRESULT MoveFirst(	BSTR VARIANT_BOOL	bstrTariffType, *pbStatus);
[C/C++ return value]	S_OK	This value is returned if the function call was successful.
	S_FALSE	This value is returned if the end of an iteration is reached
	E_name	This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.

Calling argument description
[in] BSTR	bstrTariffType	The tariff type for which the positioning methods (MoveNext etc.) act and for which the position is set to the first record. All other positioning methods act upon the same tariff.
[out,retval] VARIANT_BOOL	*pbStatus	Return the status of the method. If pbStatus is VARIANT_TRUE than all is OK. whereas VARIANT_FALSE means that the action could no be completed due to an "end_of_data" message or an error situation. Call GetAbortInfo to check for possible errors.