Purpose
Get a property
of a model.
Synopsis
int XPRMgetmodprop(XPRMmodel model, int prop, XPRMalltypes *value);
Arguments
|
model
|
Reference to a model
|
|
prop
|
Property to retrieve. Possible values:
|
XPRM_PROP_NAME
|
Model name (
cf.
model statement)
|
|
XPRM_PROP_ID
|
Order number
|
|
XPRM_PROP_VERSION
|
Model version
|
|
XPRM_PROP_SYSCOM
|
System comment
|
|
XPRM_PROP_USRCOM
|
User comment
|
|
XPRM_PROP_SIZE
|
Amount of memory (in bytes) used by the model
|
|
XPRM_PROP_NBBIM
|
Number of BIM files loaded for this model
|
|
XPRM_PROP_DATE
|
Compilation date
|
|
XPRM_PROP_SECSTAT
|
Security status
|
|
XPRM_PROP_SKEYFP
|
Key fingerprint (if the BIM file was signed)
|
|
XPRM_PROP_NBTYPES
|
Number of types
|
|
XPRM_PROP_UNAME
|
Unique model name
|
|
|
value
|
Pointer to an area where the model property is returned
|
Return value
0 if successful, 1 otherwise.
Further information
1. This function returns information about a given model. The type of the property (specified via the
prop argument) decides how the argument
value is interpreted: the field
integer is used for
ID,
VERSION,
SECSTAT,
NBBIM and
NBTYPES;
size for
SIZE and
DATE (should be casted to the C type
time_t); and
string for the other properties. The returned version number is coded as an integer, for example,
1.2.3 is coded as
1002003.
2. The
security status is a bit encoded integer indicating whether the BIM file was encrypted (value
XPRM_SECSTAT_CRYPTED); signed (value
XPRM_SECSTAT_SIGNED). If the BIM file was signed, the bits
XPRM_SECSTAT_VERIFIED and
XPRM_SECSTAT_UNVERIFIED indicate whether the signature was valid (if none of these bits is set the signature was not checked).
3. The property
NBBIM returns the number of BIM files loaded for the model: if there is no dynamic package dependency (either the model does not use any package or all packages are imported) this property will be
1.
4. The function can also be used to retrieve information about packages dynamically loaded for the model (
i.e. property
NBBIM is greater than
1) by using the macro
XPRM_PROP to generate the
prop parameter. For instance to retrieve the version number of the first package required by the model use
XPRM_PROP(XPRM_PROP_VERSION,1).
© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the
property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not
convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except
solely for internal evaluation purposes to determine whether to purchase a license to the software
described in this documentation, or as otherwise set forth in a written software license agreement
between you and FICO (or a FICO affiliate). Use of this documentation and the software described in
it must conform strictly to the foregoing permitted uses, and no other use is permitted.
