MCFIMInfo Class Methods
In this section, the MCFIMInfo class methods are presented in alphabetical order.
Syntax
AddUser(User)
Description
Use the AddUser method to add a user to the instant messaging session.
Parameters
|
Field or Control |
Definition |
|---|---|
| User |
Specify the user that you want to add to the instant messaging session, as a string. |
Returns
A Boolean value: True if the user was successfully added, False otherwise.
Syntax
CheckAll()
Description
Use the CheckAll method to check the status of users on the instant messaging session.
This method makes the actual network requests to retrieve presence information.
Parameters
None.
Returns
A Boolean: True if the check is successful, False otherwise.
Syntax
GetAdditionalUserInfo()
Description
This method returns additional user information.
Parameters
None.
Returns
String.
Syntax
GetErrorImageName()
Description
Use GetErrorImageName to return the name of the image used for errors.
Parameters
None.
Returns
String.
Syntax
GetOffLineImageName()
Description
Use GetOffLineImageName to return the name of the image used to indicate off line status.
Parameters
None.
Returns
String.
Syntax
GetOnlineImageName()
Description
Use GetOnlineImageName to return the name of the image used to indicate online status.
Parameters
None.
Returns
String.
Syntax
GetUnknownImageName()
Description
Use GetUnknownImageName to return the image of unknown users.
Parameters
None.
Returns
String.
Syntax
GetLaunchURL(User)
Description
Use the GetLaunchURL method to return the URL that launches the native client and contacts the user. This is a local URL of one of the following forms:
aim:. . . or
ymsgr:. . .Parameters
|
Field or Control |
Definition |
|---|---|
| User |
Specify the user that you want to contact via the launch URL. |
Returns
A string representing the URL to launch the native client.
Syntax
GetStatus(User)
Description
Use the GetStatus method to return the current online status of the user specified by User. This is the status at the time of the last call to CheckAll.
Parameters
|
Field or Control |
Definition |
|---|---|
| User |
Specify the name of the user for whom you want to check the status of. |
Returns
An integer. The values are:
|
Value |
Description |
|---|---|
|
-1 |
Network Disabled |
|
0 |
User offline |
|
1 |
User online |
|
2 |
User Unknown |
|
3 |
Error |
Syntax
RemoveUser(User)
Description
Use the RemoveUser method to remove a user from the instant messaging session.
Parameters
|
Field or Control |
Definition |
|---|---|
| User |
Specify the name of the user you want to remove from the session, as a string. |
Returns
A Boolean value: True if the user was successfully removed, False otherwise.