Provides the user status of the calling client, which can be read by a script that is not running from a Web page. This property cannot be set from any script.

Syntax

HRESULT MyStatus(
   [in] MISTATUS mStatus
);

Parameters

mStatus

Pointer to a variable of type MISTATUS that receives the current status for the local client.

Return Value

Returns one of the following values. For managed code applications, these return values are received in the form of a COMException.

S_OK

Success.

RPC_X_NULL_REF_POINTER

pmiStatus is a null pointer.

Remarks

If the local client is offline, this property returns without attempting to connect. Otherwise, this property queries the server for the client's local state; it does not use locally stored information. The property value returned is a string representation of a HEX value.

Example

The myStatus property returns a MISTATUS ENUM value even when the local client is offline.

Copy Code
private void askForMyStatusButtonClick(object sender, EventArgs e)
{
  if (communicator != null)
  {
	 string myStatus = null;
	 try
	 {
		 myStatus = communicator.MyStatus.ToString();
		 if (myStatus != null)
			 Console.WriteLine("My Status: " + myStatus);
	 }
	 catch (COMException)
	 {
		myStatus = "Off Line";
		Console.WriteLine("My Status: " + myStatus);
	 }
  }
}

Requirements

Client

Requires Microsoft DirectX 9.0, C Runtime libraries (msvcm80.dll) on Microsoft Windows© Vista, Microsoft Windows XP Service Pack 1 (SP1) or later, or Microsoft Windows 2000 with Service Pack 4 (SP4). Any Communicator-imposed restrictions apply. .

Server

Requires Microsoft Office Communications Server 2007, AV MCU (for Media Support), Media Relay (for NAT/Firewall traversal) on Microsoft Office Communications Server 2007.

Product

Microsoft Office Communicator 2007 Automation API

IDL file

Msgrua.idl

See Also