Run just before a file is checkedout - a non ok response should be returned if the event is to fail

Namespace: SynergyServerScripting
Assembly: SynergyServerScripting (in SynergyServerScripting.dll)

Public Overridable Function OnBeforeFileCheckedout( _ 
ByVal file_id As EntityID, _ 
ByVal database As IDatabase, _ 
ByVal user_id As EntityID, _ 
ByVal client As IClient, _ 
ByVal client_event_id As Long
) As OperationResponse
This language is not supported or no code example is available.
public virtual OperationResponse OnBeforeFileCheckedout( 
EntityID file_id
IDatabase database
EntityID user_id
IClient client
long client_event_id 
)
This language is not supported or no code example is available.
public:  
virtual OperationResponse^ OnBeforeFileCheckedout( 
EntityID^ file_id
IDatabase^ database
EntityID^ user_id
IClient^ client
long client_event_id 
)
This language is not supported or no code example is available.
public function OnBeforeFileCheckedout( 
file_id : EntityID
database : IDatabase
user_id : EntityID
client : IClient
client_event_id : long 
) : OperationResponse;
This language is not supported or no code example is available.

Parameters

file_id
Type: EntityID

the id of the file to be checked out

database
Type: IDatabase

the database id

user_id
Type: EntityID

the id of the user performing the event

client
Type: IClient

client_event_id
Type: long

the client event id

Return Value

Type: OperationResponse

the operation response - error level if it should fail

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1