Export (0) Print
Expand All

SRV_OPEN_ECP_CONTEXT structure

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;
} SRV_OPEN_ECP_CONTEXT, *PSRV_OPEN_ECP_CONTEXT;

Members

ShareName

A pointer to a UNICODE_STRING structure that supplies the share name for the server that contains the files to be open.

SocketAddress

A pointer to a SOCKADDR_STORAGE structure that specifies the transport address of a client computer. This client originates the open file request.

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.

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

Version

This structure is available starting with Windows 7.

Header

Ntifs.h (include Ntifs.h)

See also

SOCKADDR_STORAGE
UNICODE_STRING

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft