CloseHardLinksEnumeration Event

Fires when the OS is finished enumerating a file's hard links.

Syntax

// CBFSCloseHardLinksEnumerationEventArgs carries the CBFS CloseHardLinksEnumeration event's parameters.
type CBFSCloseHardLinksEnumerationEventArgs struct {...}

func (args *CBFSCloseHardLinksEnumerationEventArgs) FileName() string
func (args *CBFSCloseHardLinksEnumerationEventArgs) HandleInfo() int64
func (args *CBFSCloseHardLinksEnumerationEventArgs) FileContext() int64
func (args *CBFSCloseHardLinksEnumerationEventArgs) SetFileContext(value int64)
func (args *CBFSCloseHardLinksEnumerationEventArgs) HandleContext() int64
func (args *CBFSCloseHardLinksEnumerationEventArgs) SetHandleContext(value int64)
func (args *CBFSCloseHardLinksEnumerationEventArgs) EnumerationContext() int64
func (args *CBFSCloseHardLinksEnumerationEventArgs) ResultCode() int32
func (args *CBFSCloseHardLinksEnumerationEventArgs) SetResultCode(value int32)

// CBFSCloseHardLinksEnumerationEvent defines the signature of the CBFS CloseHardLinksEnumeration event's handler function.
type CBFSCloseHardLinksEnumerationEvent func(sender *CBFS, args *CBFSCloseHardLinksEnumerationEventArgs)

func (obj *CBFS) GetOnCloseHardLinksEnumerationHandler() CBFSCloseHardLinksEnumerationEvent
func (obj *CBFS) SetOnCloseHardLinksEnumerationHandler(handlerFunc CBFSCloseHardLinksEnumerationEvent)

Remarks

This event fires when the OS is finished enumerating the hard links of the file specified by FileName.

This event only needs to be handled if the UseHardLinks property is enabled. To handle this event properly, applications must release any resources that were allocated for/by the hard link enumeration in earlier EnumerateHardLinks events.

The HandleInfo parameter carries a handle to an object with information about the file handle. While within the event handler, it can be used to call any of the following methods: GetHandleCreatorProcessId, GetHandleCreatorProcessName, GetHandleCreatorThreadId, or GetHandleCreatorToken.

The FileContext, HandleContext, and EnumerationContext parameters are placeholders for application-defined data associated with the file, specific handle, and enumeration; respectively. Please refer to the Contexts topic for more information.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Go Edition - Version 20.0 [Build 8348]