Skype4COM: IConversion Interface Reference

Skype4COM

IConversion Interface Reference

Conversion class default interface. More...

import "Skype4COM.idl";

List of all members.

Public Member Functions

HRESULT OnlineStatusToText ([in] TOnlineStatus status,[out, retval] BSTR *pVal)
 This command converts a user's online status from status code to text.
HRESULT TextToOnlineStatus ([in] BSTR Text,[out, retval] TOnlineStatus *pVal)
 This command converts text to online status code.
HRESULT BuddyStatusToText ([in] TBuddyStatus status,[out, retval] BSTR *pVal)
 This command converts contact status to text.
HRESULT TextToBuddyStatus ([in] BSTR Text,[out, retval] TBuddyStatus *pVal)
 This command converts contact status text to contact status code.
HRESULT CallStatusToText ([in] TCallStatus Status,[out, retval] BSTR *pVal)
 This command converts call status to text.
HRESULT TextToCallStatus ([in] BSTR Text,[out, retval] TCallStatus *pVal)
 This command converts call status text to call status code.
HRESULT CallTypeToText ([in] TCallType CallType,[out, retval] BSTR *pVal)
 This command converts the call type to text.
HRESULT TextToCallType ([in] BSTR Text,[out, retval] TCallType *pVal)
 This command converts call type text to call type code.
HRESULT UserSexToText ([in] TUserSex Sex,[out, retval] BSTR *pVal)
 This command converts user sex value to text.
HRESULT TextToUserSex ([in] BSTR Text,[out, retval] TUserSex *pVal)
 This command converts the user sex text string to code.
HRESULT ConnectionStatusToText ([in] TConnectionStatus Status,[out, retval] BSTR *pVal)
 This command converts the connection status to a text string.
HRESULT TextToConnectionStatus ([in] BSTR Text,[out, retval] TConnectionStatus *pVal)
 This command converts a text string of connection status to a code value.
HRESULT UserStatusToText ([in] TUserStatus Status,[out, retval] BSTR *pVal)
 This command converts the user status value to a text string.
HRESULT TextToUserStatus ([in] BSTR Text,[out, retval] TUserStatus *pVal)
 This command converts a string of user status to a code value.
HRESULT CallFailureReasonToText ([in] TCallFailureReason reason,[out, retval] BSTR *pVal)
 This command converts a failure reason to a text string.
HRESULT AttachmentStatusToText ([in] TAttachmentStatus status,[out, retval] BSTR *pVal)
 This command converts an attachment status code to a text string.
HRESULT ChatLeaveReasonToText ([in] TChatLeaveReason reason,[out, retval] BSTR *pVal)
 This command converts a leave reason to a text string.
HRESULT ChatStatusToText ([in] TChatStatus status,[out, retval] BSTR *pVal)
 This command converts a chat status code to a text string.
HRESULT VoicemailTypeToText ([in] TVoicemailType type,[out, retval] BSTR *pVal)
 This command converts a voicemail type to a text string.
HRESULT VoicemailStatusToText ([in] TVoicemailStatus status,[out, retval] BSTR *pVal)
 This command converts a voicemail status to a text string.
HRESULT TextToVoicemailStatus ([in] BSTR Text,[out, retval] TVoicemailStatus *pVal)
 This command converts a voicemail status text string to code.
HRESULT VoicemailFailureReasonToText ([in] TVoicemailFailureReason code,[out, retval] BSTR *pVal)
 This command converts a voicemail failure reason to a text string.
HRESULT ChatMessageStatusToText ([in] TChatMessageStatus Status,[out, retval] BSTR *pVal)
 Thic command converts message status code to text.
HRESULT TextToChatMessageStatus ([in] BSTR Text,[out, retval] TChatMessageStatus *pVal)
 This command converts a message status from text to code.
HRESULT ChatMessageTypeToText ([in] TChatMessageType Type,[out, retval] BSTR *pVal)
 This command converts the message type code to text.
HRESULT TextToChatMessageType ([in] BSTR Text,[out, retval] TChatMessageType *pVal)
 This command converts a message type from text string to code.
HRESULT TextToAttachmentStatus ([in] BSTR Text,[out, retval] TAttachmentStatus *pVal)
 This command converts an attachment status text string to code.
HRESULT GroupTypeToText ([in] TGroupType Type,[out, retval] BSTR *pVal)
 This command converts a group type to a text string.
HRESULT TextToGroupType ([in] BSTR Text,[out, retval] TGroupType *pVal)
 This command converts a text group type to a code value.
HRESULT CallVideoStatusToText ([in] TCallVideoStatus Status,[out, retval] BSTR *pVal)
 This command converts call video status to a text string.
HRESULT CallVideoSendStatusToText ([in] TCallVideoSendStatus Status,[out, retval] BSTR *pVal)
 This command converts call video send status to a text string.
HRESULT SmsMessageStatusToText ([in] TSmsMessageStatus status,[out, retval] BSTR *pVal)
 This command converts SMS message status to a text string.
HRESULT SmsMessageTypeToText ([in] TSmsMessageType type,[out, retval] BSTR *pVal)
 This command converts SMS message type to a text string.
HRESULT SmsTargetStatusToText ([in] TSmsTargetStatus status,[out, retval] BSTR *pVal)
 This command converts SMS target status to a text string.

Properties

BSTR Language [get, set]
 This command queries/sets the language to use for a text conversion.

Detailed Description

Conversion class default interface.

This interface converts Skype4COM constant values to text and converts text back to constant values.

See also:
Refer to the Skype4COM Dev Notes for more information about conversion.

Member Function Documentation

HRESULT AttachmentStatusToText ( [in] TAttachmentStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts an attachment status code to a text string.

Parameters:
[in]statuscontains the attachment status code.
[out]pValreceives the converted attachment status as a text string.
HRESULT BuddyStatusToText ( [in] TBuddyStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts contact status to text.

Parameters:
[in]statusis the contact status value.
[out]pValreceives the contact status value as a text string.
HRESULT CallFailureReasonToText ( [in] TCallFailureReason  reason,
[out, retval] BSTR *  pVal 
)

This command converts a failure reason to a text string.

Parameters:
[in]reasoncontains a failure reason code.
[out]pValreceives the failure reason as a text string.
HRESULT CallStatusToText ( [in] TCallStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts call status to text.

Parameters:
[in]statuscontains the call status value.
[out]pValreceives the call status as a text string.
HRESULT CallTypeToText ( [in] TCallType  CallType,
[out, retval] BSTR *  pVal 
)

This command converts the call type to text.

Parameters:
[in]CallTypecontains the call type value.
[out]pValreceives the call type value as a text string .
HRESULT CallVideoSendStatusToText ( [in] TCallVideoSendStatus  Status,
[out, retval] BSTR *  pVal 
)

This command converts call video send status to a text string.

Parameters:
[in]Statuscontains the video send status code.
[out]pValreceives the video send status as a text string.
HRESULT CallVideoStatusToText ( [in] TCallVideoStatus  Status,
[out, retval] BSTR *  pVal 
)

This command converts call video status to a text string.

Parameters:
[in]Statuscontains the video status code.
[out]pValreceives the converted code as a text string.
HRESULT ChatLeaveReasonToText ( [in] TChatLeaveReason  reason,
[out, retval] BSTR *  pVal 
)

This command converts a leave reason to a text string.

Parameters:
[in]reasoncontains a leave reason code.
[out]pValreceives a leave reason as a text string.
HRESULT ChatMessageStatusToText ( [in] TChatMessageStatus  Status,
[out, retval] BSTR *  pVal 
)

Thic command converts message status code to text.

Parameters:
[in]Statuscontains the message status value.
[out]pValreceives the message status as a text string.
HRESULT ChatMessageTypeToText ( [in] TChatMessageType  Type,
[out, retval] BSTR *  pVal 
)

This command converts the message type code to text.

Parameters:
[in]Typecontains the message type code.
[out]pValreceives the message type as a text string.
HRESULT ChatStatusToText ( [in] TChatStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts a chat status code to a text string.

Parameters:
[in]statuscontains the chat status code.
[out]pValreceives the converted chat status as a text string.
HRESULT ConnectionStatusToText ( [in] TConnectionStatus  Status,
[out, retval] BSTR *  pVal 
)

This command converts the connection status to a text string.

Parameters:
[in]Statuscontains the connection status value.
[out]pValreceives the connection status value as a text string.
HRESULT GroupTypeToText ( [in] TGroupType  Type,
[out, retval] BSTR *  pVal 
)

This command converts a group type to a text string.

Parameters:
[in]Typecontains the group type code.
[out]pValreceives the group type as a text string.
HRESULT OnlineStatusToText ( [in] TOnlineStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts a user's online status from status code to text.

Parameters:
[in]statusis the online status value.
[out]pValreceives a text string of the current online status.
HRESULT SmsMessageStatusToText ( [in] TSmsMessageStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts SMS message status to a text string.

Parameters:
[in]statuscontains SMS message status.
[out]pValreceives the status as text string.
HRESULT SmsMessageTypeToText ( [in] TSmsMessageType  type,
[out, retval] BSTR *  pVal 
)

This command converts SMS message type to a text string.

Parameters:
[in]typecontains SMS message type.
[out]pValreceives the type as text string.
HRESULT SmsTargetStatusToText ( [in] TSmsTargetStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts SMS target status to a text string.

Parameters:
[in]statuscontains SMS target status.
[out]pValreceives the status as text string.
HRESULT TextToAttachmentStatus ( [in] BSTR  Text,
[out, retval] TAttachmentStatus pVal 
)

This command converts an attachment status text string to code.

Parameters:
[in]Textcontains a text string ("UNKNOWN","SUCCESS","PENDING","REFUSED","NOTAVAILABLE","AVAILABLE").
[out]pValreceives the converted text attachment status as as status code.
HRESULT TextToBuddyStatus ( [in] BSTR  Text,
[out, retval] TBuddyStatus pVal 
)

This command converts contact status text to contact status code.

Parameters:
[in]Textcontains a text string of the contact status.
[out]pValreceives the contact status code.
HRESULT TextToCallStatus ( [in] BSTR  Text,
[out, retval] TCallStatus pVal 
)

This command converts call status text to call status code.

Parameters:
[in]Textcontains a string ("UNPLACED", "ROUTING", "EARLYMEDIA", "FAILED", "RINGING", "INPROGRESS", "ONHOLD", "FINISHED", "MISSED", "REFUSED", "BUSY", "LOCALHOLD", "REMOTEHOLD").
[out]pValreceives the call status text as a call status code.
HRESULT TextToCallType ( [in] BSTR  Text,
[out, retval] TCallType pVal 
)

This command converts call type text to call type code.

Parameters:
[in]Textcontains a text string ("INCOMING_PSTN", "OUTGOING_PSTN", "INCOMING_P2P", "OUTGOING_P2P").
[out]pValreceives the call type as call type code.
HRESULT TextToChatMessageStatus ( [in] BSTR  Text,
[out, retval] TChatMessageStatus pVal 
)

This command converts a message status from text to code.

Parameters:
[in]Textcontains a text string of the message status.
[out]pValreceives the text string as message status code.
HRESULT TextToChatMessageType ( [in] BSTR  Text,
[out, retval] TChatMessageType pVal 
)

This command converts a message type from text string to code.

Parameters:
[in]Textcontains a text string for the message type.
[out]pValreceives the message type in code.
HRESULT TextToConnectionStatus ( [in] BSTR  Text,
[out, retval] TConnectionStatus pVal 
)

This command converts a text string of connection status to a code value.

Parameters:
[in]Textcontains a text string ("OFFLINE", "CONNECTING", "PAUSING", "ONLINE", "LOGGEDOUT").
[out]pValreceives the converted text string as connection status code.
HRESULT TextToGroupType ( [in] BSTR  Text,
[out, retval] TGroupType pVal 
)

This command converts a text group type to a code value.

Parameters:
[in]Textcontains a text string ("CUSTOM_GROUP", "ALL_USERS", "ALL_FRIENDS", "SKYPE_FRIENDS", "SKYPEOUT_FRIENDS", "ONLINE_FRIENDS", "UNKNOWN_OR_PENDINGAUTH_FRIENDS", "RECENTLY_CONTACTED_USERS", "USERS_WAITING_MY_AUTHORIZATION", "USERS_AUTHORIZED_BY_ME", "USERS_BLOCKED_BY_ME", "UNGROUPED_FRIENDS", "SHARED_GROUP", "PROPOSED_SHARED_GROUP")
[out]pValreceives the converted text group type as code.
HRESULT TextToOnlineStatus ( [in] BSTR  Text,
[out, retval] TOnlineStatus pVal 
)

This command converts text to online status code.

Parameters:
[in]Textcontains a text string ("OFFLINE", "ONLINE", "AWAY", "NA", "DND", "SKYPEME", "SKYPEOUT").
[out]pValreceives the online status code.
HRESULT TextToUserSex ( [in] BSTR  Text,
[out, retval] TUserSex pVal 
)

This command converts the user sex text string to code.

Parameters:
[in]Textcontains a text string ("UNKNOWN", "MALE", "FEMALE").
[out]pValreceives the converted text string as user sex code.
HRESULT TextToUserStatus ( [in] BSTR  Text,
[out, retval] TUserStatus pVal 
)

This command converts a string of user status to a code value.

Parameters:
[in]Textcontains a text string ("OFFLINE", "ONLINE", "AWAY", "NA", "DND", "INVISIBLE", "LOGGEDOUT", "SKYPEME").
[out]pValreceives the converted text string as a user status code.
HRESULT TextToVoicemailStatus ( [in] BSTR  Text,
[out, retval] TVoicemailStatus pVal 
)

This command converts a voicemail status text string to code.

Parameters:
[in]Textcontains a text string ("NOTDOWNLOADED", "DOWNLOADING", "UNPLAYED", "BUFFERING", "PLAYING", "PLAYED", "BLANK", "RECORDING", "RECORDED", "UPLOADING", "UPLOADED", "DELETING", "FAILED", "UNKNOWN").
[out]pValreceives the converted voicemail status text as code.
HRESULT UserSexToText ( [in] TUserSex  Sex,
[out, retval] BSTR *  pVal 
)

This command converts user sex value to text.

Parameters:
[in]Sexcontains the user sex value.
[out]pValreceives the user sex value as a text string.
HRESULT UserStatusToText ( [in] TUserStatus  Status,
[out, retval] BSTR *  pVal 
)

This command converts the user status value to a text string.

Parameters:
[in]Statuscontains the user status value.
[out]pValreceives the user status value as a text string.
HRESULT VoicemailFailureReasonToText ( [in] TVoicemailFailureReason  code,
[out, retval] BSTR *  pVal 
)

This command converts a voicemail failure reason to a text string.

Parameters:
[in]codecontains the voicemail failure reason code.
[out]pValreceives the converted voicemail failure reason as a text string.
HRESULT VoicemailStatusToText ( [in] TVoicemailStatus  status,
[out, retval] BSTR *  pVal 
)

This command converts a voicemail status to a text string.

Parameters:
[in]statuscontains the voicemail status code.
[out]pValreceives the converted voicemail status as a text string.
HRESULT VoicemailTypeToText ( [in] TVoicemailType  type,
[out, retval] BSTR *  pVal 
)

This command converts a voicemail type to a text string.

Parameters:
[in]typecontains the voicemail type code.
[out]pValreceives the converted voicemail type as a text string.

The documentation for this interface was generated from the following file:

Copyright � 2006 Skype Limited. All rights reserved.