API browser of pushAdminMessage450 COM module


/images/arrow_right.png IPushAdminMessageManager::PrintSetup method space
Shows the printer setup dialog that allows to define the printer and its settings. When saving the data the selected printer and the currently used computer is connected with the given .vps report generator file.
space
/images/arrow_right.png Restful webservice calling syntax
This method has no Restful Webservice representation!
space
/images/arrow_right.png C/C++ calling syntax
HRESULT PrintSetup( BSTR
BSTR
VARIANT_BOOL
bstrPrintTemplate,
bstrINIPath,
*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 bstrPrintTemplate Either the full file name (path + name) or a logical name of a target .vps report generator file for which the settings will be defined.
 
There are predefined .vps files in the installation directory that can be accessed via the following case insensitive logical name:
Detail[_version]_addressSide_language
- the single-page admin message template for all laws
where
  • version is 450, the absence of a version identifier defaults to 450
  • language is one of {dt, fr, it}.
  • addressSide is R for right sided addressing of the recipient.

For example the logical name "Detail_R_fr" is the French print template of version 450 with right sided addressing.
[in] BSTR bstrINIPath Optional path to a directory where the .vpd printer setting file is stored. The name of the printer setting file is the same name as the .vps file but with a .vpd extension.
 
If bstrINIPath is left empty then the standard directory (the directory of the dll) is used.
[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