API browser of generalFormRequest430 COM module


/images/arrow_right.png IForms::GetObjectInfo method
The GetObjectInfo method returns information about a given a medForms OID either in its full or shortened form. space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetObjectInfo( LanguageType
BSTR
BSTR
BSTR
YesNoType
BSTR
VARIANT_BOOL
eDataLanguage,
bstrOID,
*pbstrUID,
*pbstrName,
*peIsFile,
*pbstrFile,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] LanguageType eDataLanguage The language branch of the form space to use.
[in] BSTR bstrOID The medForms OID for which the information should be retrieved. Note that the OID can be in its full or shortened form.
[out] BSTR *pbstrUID The UID of the form space node or PDF form template.

The UID might be empty if such an UID can not be found

[out] BSTR *pbstrName The descriptive name of the form space node or PDF form template
[out] YesNoType *peIsFile A Boolean denoting if the object is a node (enNo) or a PDF form template (enYes)
[out] BSTR *pbstrFile The name of the PDF form template if eIsFile=enYes or empty otherwise

Alternatively to the OID this file name can be used in the IGeneralFormRequestManager::LoadPDF method to load this PDF template.

[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then the object can not be found.
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
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.