API browser of pushAdminMessage450 COM module


/images/arrow_right.png IAddress::SetOnline method space
Sets the structured online part of the address.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IAddress/SetOnline
[JSON input data] pIAddress:
bstrEMail:
bstrUrl:
longValue,    //interface address
"utf8StringValue",
"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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT SetOnline( BSTR
BSTR
VARIANT_BOOL
bstrEMail,
bstrUrl,
*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.
space
/images/arrow_right.png Calling argument description
[in] BSTR bstrEMail A relevant email address.
[in] BSTR bstrUrl A relevant URL address.
[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.
space