API browser of generalFormRequest450 COM module


/images/arrow_right.png IAddress::GetOnline method space
Retrieves the structured online part of the address.

Empty variables are returned if there is no online information available.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IAddress/GetOnline
[JSON input data] pIAddress: longValue,    //interface address
[JSON result data] pbstrEMail:
pbstrUrl:
pbStatus:
"utf8StringValue",
"utf8StringValue",
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 GetOnline( BSTR
BSTR
VARIANT_BOOL
*pbstrEMail,
*pbstrUrl,
*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
[out] BSTR *pbstrEMail A relevant email address.
[out] BSTR *pbstrUrl A relevant URL.
[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