SRV_OPEN_ECP_CONTEXT structure (ntifs.h)

The SRV_OPEN_ECP_CONTEXT structure is used by a server to conditionally open files in response to client requests.

Syntax

typedef struct _SRV_OPEN_ECP_CONTEXT {
  PUNICODE_STRING       ShareName;
  PSOCKADDR_STORAGE_NFS SocketAddress;
  BOOLEAN               OplockBlockState;
  BOOLEAN               OplockAppState;
  BOOLEAN               OplockFinalState;
  USHORT                Version;
  SRV_INSTANCE_TYPE     InstanceType;
} SRV_OPEN_ECP_CONTEXT, *PSRV_OPEN_ECP_CONTEXT;

Members

ShareName

Pointer to a UNICODE_STRING structure that supplies the share name for the server that contains the files to be open. This field is optional and can be NULL.

SocketAddress

Pointer to a SOCKADDR_STORAGE structure that specifies the transport address of a client computer. This client originates the open file request. This field is optional and can be a NULL.

OplockBlockState

A Boolean value that indicates whether the Server Message Block (SMB) server blocks the open thread that is waiting for the oplock break. TRUE indicates that the open thread is in the blocking state and FALSE otherwise.

OplockAppState

A Boolean value that indicates whether the SMB server requests an oplock with the current open thread. Set to TRUE to request the oplock and FALSE otherwise.

OplockFinalState

A Boolean value that indicates whether a file-open operation is the final file-open operation to request the oplock. TRUE indicates the final file-open operation to obtain the oplock and FALSE indicates otherwise.

Version

Version of this structure. This member was added in Windows 10 version 1703, so before trying to access it you must first check to see if it exists. If the structure size is >= RTL_SIZEOF_THROUGH_FIELD(SRV_OPEN_ECP_CONTEXT, Version), you can access this field. This member can be currently be set to SRV_OPEN_ECP_CONTEXT_VERSION_2.

InstanceType

The SRV_INSTANCE_TYPE that the open is coming from. File system minifilters that attach to NTFS or ReFS used by CSVFS can use this field to detect if this open is bypassing CSVFS. If the open goes through CSVFS, then this ECP is either absent or the instance type is SrvInstanceTypeCsv. If the open is bypassing CSVFS and goes directly to the hidden volume, then InstanceType is SrvInstanceTypePrimary. The InstanceType field is present only if Version is >= SRV_OPEN_ECP_CONTEXT_VERSION_2.

Remarks

The file-system stack can determine whether SRV_OPEN_ECP_CONTEXT is attached to the create file request. The file-system stack can then use the information in SRV_OPEN_ECP_CONTEXT to determine which client requested that the file be opened, and why it requested it. For information about how to retrieve the SRV_OPEN_ECP_CONTEXT extra information that is attached to a create file request, see Retrieving ECPs.

The SRV_OPEN_ECP_CONTEXT structure is read-only. You should use it to retrieve information about a server open ECP only. For more information about this issue, see System-Defined ECPs.

The oplock state values (OplockBlockState, OplockAppState, and OplockFinalState) are used with oplock breaking logic for system management for SMB and SMB2.

Requirements

Requirement	Value
Minimum supported client	This structure is available starting with Windows 7.
Header	ntifs.h (include Ntifs.h)

See also

SOCKADDR_STORAGE

SRV_INSTANCE_TYPE

UNICODE_STRING