plpUtilities
plpUtilities
plpUtilities
utilities to handle plp functionalitys
Metadata
fAddArrayObjects()
Add a list of object ids to the plp array properties
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
|
| lAddObjectid |
string |
Yes |
|
|
|
| propertieName |
string |
No |
aObjectIDs |
|
name of the array you wish to return |
| bPLPStorage |
string |
No |
yes |
|
flag whether to read for plp file or object database |
fAppendPropertie()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
primary object id of the plp |
| propertieName |
string |
Yes |
|
|
the name of the plp propertie you wish to update |
| propertieValue |
string |
Yes |
|
|
the value of the plp propertie you wish to update |
| bPLPStorage |
string |
No |
yes |
|
|
fDeleteArrayObjects()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
|
| lDelObjectid |
string |
Yes |
|
|
|
| propertieName |
string |
No |
aObjectIDs |
|
name of the array you wish to return |
| bPLPStorage |
string |
No |
yes |
|
flag whether to read for plp file or object database |
fGenerateObjectsArray()
returns ar[0].text,ar[0].value'
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
|
| lTypename |
string |
Yes |
|
|
|
| propertieName |
string |
No |
aObjectIDs |
|
name of the array you wish to return |
| bPLPStorage |
string |
No |
yes |
|
flag whether to read for plp file or object database |
fGetArrayObjects()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
primary object id of the plp |
| propertieName |
string |
No |
aObjectIDs |
|
name of the array you wish to return |
| bPLPStorage |
string |
No |
yes |
|
|
fRead()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
|
| bPLPStorage |
string |
No |
yes |
|
|
fReadPropertie()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
primary object id of the plp |
| propertieName |
string |
No |
aObjectIDs |
|
name of the array you wish to return |
| bPLPStorage |
string |
No |
yes |
|
|
fReplaceBadCharacters()
replace bad cahracters with their html equivalent
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| inStr |
string |
Yes |
|
|
|
fRepositionArrayObjects()
reposition a plp properties array or list
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| objectid |
uuid |
Yes |
|
|
|
| lobjectid |
string |
Yes |
|
|
|
| propertieName |
string |
No |
aObjectIDs |
|
name of the array you wish to return |
| bPLPStorage |
string |
No |
yes |
|
flag whether to read for plp file or object database |
fWrite()
Arguments
| Name |
Type |
Required |
Default |
Options |
Description |
| stPLP |
struct |
Yes |
|
|
|
| bPLPStorage |
string |
No |
yes |
|
|