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


/images/arrow_right.png IAddress::GetFax method space
Retrieves the structured fax number.
 
Empty variables are returned if there is no fax number available.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IAddress/GetFax
[JSON input data] pIAddress: longValue,    //interface address
[JSON result data] pbstrNumber:
pbstrLocalCode:
pbstrInternationalCode:
pbstrExt:
pbStatus:		 "utf8StringValue",
"utf8StringValue",
"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 GetFax( BSTR
BSTR
BSTR
BSTR
VARIANT_BOOL 		*pbstrNumber,
*pbstrLocalCode,
*pbstrInternationalCode,
*pbstrExt,
*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 *pbstrNumber The pure fax number part of the full fax number.
 
It is possible that the full fax number is returned in this variable and the other parts of the fax number left empty.
[out] BSTR *pbstrLocalCode The local area code part of the fax number.
[out] BSTR *pbstrInternationalCode The international calling code part of the fax number.
[out] BSTR *pbstrExt 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