Namespace: Microsoft.Clm.Provision
Assembly: Microsoft.Clm.Provision (in microsoft.clm.provision.dll)
Usage
Visual Basic |
---|
Dim request As Request Dim comment As String Dim returnValue As Request returnValue = RequestOperations.Abandon(request, comment) |
Syntax
Visual Basic |
---|
Public Shared Function Abandon ( _ request As Request, _ comment As String _ ) As Request |
C# |
---|
public static Request Abandon ( Request request, string comment ) |
C++ |
---|
public: static Request^ Abandon ( Request^ request, String^ comment ) |
J# |
---|
public static Request Abandon ( Request request, String comment ) |
JScript |
---|
public static function Abandon ( request : Request, comment : String ) : Request |
Parameters
- request
-
A Request object that describes the FIM CM request to be abandoned. The status of the FIM CM request must be Approved or Executing.
- comment
-
A String object that contains a comment to be included in the history of the FIM CM request. Set this parameter to Null for no comment.
Return Value
The Request object after it has been abandoned by the current user. The status of the FIM CM request is set to Failed.Remarks
The following permissions are checked when this method is called:
-
The current user must have Read permissions on the profile template.
-
The current user must have Execute permissions on the FIM CM request.
If the FIM CM request has not been approved, use the Deny method to stop its processing.
Thread Safety
Any public static (Shared in Visual
Basic) members of this type are thread safe. Any instance members
are not guaranteed to be thread safe.