CRMLead.MakePrivate Method

The MakePrivate method makes a lead unavailable to anyone except the owner and the users that share the object. Only the owner of a lead can make it private. (By default, all objects are public. See Remarks.)

Syntax

[Visual Basic .NET]
Public Sub MakePrivate(
  ByVal Caller As CUserAuth,
  ByVal LeadId As String
)
[C#]
public void MakePrivate(
  CUserAuth  Caller,
  string  LeadId
);
[C++]
public: void MakePrivate(
  CUserAuth*  Caller,
  String*  LeadId
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must be the owner and have the prvWriteLead privilege. See CUserAuth.

LeadId

Specifies the ID of the lead to be made private.

Return Value

No return value.

Remarks

Note   The Microsoft CRM application does not provide an interface for making an object private. However, if an object is made private by using a third-party solution, the application recognizes this setting.

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMLead proxy object
Microsoft.Crm.Platform.Proxy.CRMLead lead = new Microsoft.Crm.Platform.Proxy.CRMLead ();
lead.Credentials = System.Net.CredentialCache.DefaultCredentials;
lead.Url = strDir + "CRMLead.srf";

string strErrorMsg;
string strLeadId = "{0876468B-8FC4-4381-8D81-C0B4D05E9386}";
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Make the lead private
   lead.MakePrivate(userAuth, strLeadId);
}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.