pushAdminMessage COM module is a data
exchange system for treatment messages
API browser of pushAdminMessage450 COM module


/images/arrow_right.png IAddress::SetFax method space
Sets a structured fax number.
 
The Swiss international calling code +41 is filtered in the printing.
If the main software does not support structured pone numbers then all data is supplied in the bstrNumber variable. However, +41 is then no longer filtered.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IAddress/SetFax
[JSON input data] pIAddress:
bstrNumber:
bstrLocalCode:
bstrInternationalCode:
bstrExt:		 longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"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 SetFax( BSTR
BSTR
BSTR
BSTR
VARIANT_BOOL 		bstrNumber,
bstrLocalCode,
bstrInternationalCode,
bstrExt,
*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 bstrNumber The pure fax number part of the fax number.
 
It is possible to set the full fax number in this variable and leave the other parts of the fax number empty
[in] BSTR bstrLocalCode The local area code part of the fax number.
[in] BSTR bstrInternationalCode The international calling code part of the fax number.
[in] BSTR bstrExt The extension number part of the fax number.
[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