API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationRequest::Initialize method space
Initializes all input data in the IGeneralNotificationRequest interface. This method is the counterpart to the Finalize method.

This method should be called before any input is set in the IGeneralNotificationRequest interface to reset all internally stored data.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralNotificationRequest/Initialize
[JSON input data] pIGeneralNotificationRequest:
eDataLanguage:
eIsConfidential:
longValue,    //interface address
longValue,
longValue
[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 Initialize( LanguageType
YesNoType
VARIANT_BOOL
eDataLanguage,
eIsConfidential,
*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] LanguageType eDataLanguage Sets the language in which the data part is coded. It is exactly the language in which the response is formulated.

Note, that the data language and the module language (given by IGeneralNotificationManager::SetModuleLanguage property) are independent and can be different!

[in] YesNoType eIsConfidential A Boolean that defines if the notification thread is confidential.

Note that the confidentiality status is defined at the moment of the initial XML infoset generation, thereafter
it must be inherited into each new reply cycle.

[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