pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage450 COM module
IPushAdminMessageRequest::Finalize method | |||
---|---|---|---|
Finalizes and validates all data set so far in the IPushAdminMessageRequest interface. This method is the counterpart to the Initialize method.
This method should be called after all data have been set in the IPushAdminMessageRequest interface since higher-level validation rules can only be called at the end of input phase. Therefore, be prepared to get validation errors at that point. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IPushAdminMessageRequest/Finalize | ||
[JSON input data] | pIPushAdminMessageRequest: | longValue, //interface address |
|
[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 Finalize( | VARIANT_BOOL | *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 | |||
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string. | |