Feedback

  • Contents
  • Index
 

MIC Get Attribute

This MIC tool retrieves MIC Object attributes and their values. For example, you may want to find out the status of a user. Specify an MIC User Object and the I3SICStatus attribute to get the values. This tool always returns an array of strings, even if only one value is requested and returned.

Inputs

MIC Object

The required MIC Object (coMicObject) to retrieve its attributes.

Attribute Name

This required string (sAttributeName) specifies the MIC object attribute to retrieve.

Depending on the object type, various attribute name strings (sAttributeName) are available. The attribute names all begin with "i3sic" and the names are NOT case sensitive.  See the MIC Objects and Attributes topic for a list of all objects and their attributes.

In addition, if the object type is User, the following intrinsic attributes are available. Each has a value of "yes" or "no" indicating if the TUI is set to play or read the related information when an MIC user calls in for messages, or when an outside contact calls an MIC user to leave a message.

  •  _opt_PlayNewEmailCount - Play the number of new email messages for the TUI user.

  •  _opt_PlayNewFaxCount - Play the number of new fax messages for the TUI user.

  •  _opt_PlayNewVoiceCount - Play the number of new voicemail messages for the TUI user.

  •  _opt_PlaySavedEmailCount - Play the number of saved email messages for the TUI user.

  •  _opt_PlaySavedFaxCount - Play the number of saved fax messages for the TUI user.

  •  _opt_PlaySavedVoiceCount - Play the number of saved voicemail messages for the TUI user.

  •  _opt_ReadVerbosePrompts - Read the verbose prompts for the TUI caller

  •  _opt_ReadOldMessagesFirst - Read the old messages first for the TUI caller

  •  _opt_ReadPriorityMessagesFirst - Read high priority messages first for the TUI caller

  •  _opt_ReadMailboxNameCaller - Read the name of the person that called for the TUI user

  •  _opt_ReadMailboxNameSubscriber - Read the name of the TUI user with the MIC account

  •  _opt_ReadStatusPromptCaller - Read the status of the MIC user to the outside caller

  •  _opt_ReadStatusPromptSubscriber - Read the status of the TUI user when he or she calls in for messages.

Outputs

Attribute Values

The list of string (lsAttributeValues) values for the specified object attributes.

Exit Code

An Exit Code (iExitCode) of 0 (zero) indicates success and a non-zero code indicates an error or other condition about the results of this tool step.

Exit Text

The exit text string (sExitText) corresponds to the Exit Code. When the Exit Code is 0, the Exit Text is "Success."

Exit Paths

Success

If an attribute is returned.

Failure

The attribute was not retrieved due to one of the following possible reasons:

Exit Code: 0x80070057

Exit Text: One or more arguments are invalid

Reason: An attribute name was not specified.

 

Exit Code: 0x80070006

Exit Text: Invalid handle

Reason: The MIC Object passed is invalid.

 

Exit Code: 0x80072076

Exit Text: The attribute specified in the operation is not present on the object.

Reason: The attribute name is invalid for the specified object.

 

Related Topics

MIC Set Attribute

MIC Objects and Attributes

MIC Get Effective Setting