getpolicystringmapResult Structure Definition

The getpolicystringmapResult structure defines the return type for getpolicystringmap API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

policystringmapList

List of policystringmaps


policystringmap Structure Definition

The policystringmap structure defines the actual return type values for getpolicystringmap API.

Syntax



Members

name

Name of the string map to display.

comment

Comments associated with the string map or key-value pair bound to this string map.

key

Character string constituting the key to be bound to the string map. The key is matched against the data processed by the operation that uses the string map. The default character set is ASCII. UTF-8 characters can be included if the character set is UTF-8. UTF-8 characters can be entered directly (if the UI supports it) or can be encoded as a sequence of hexadecimal bytes '\xNN'. For example, the UTF-8 character 'ü' can be encoded as '\xC3\xBC'.

value

Character string constituting the value associated with the key. This value is returned when processed data matches the associated key. Refer to the key parameter for details of the value character set.

_nextgenapiresource


See Also