sh_file keyword

The sh_file keyword specifies that a system_handle holds a handle to a file.

[system_handle(sh_file)]

[system_handle(sh_file, access-rights)]

Parameters

This keyword is a parameter for system_handle.

The system_handle documentation also contains details on optional use of the access-rights parameter. The default behavior is DUPLICATE_SAME_ACCESS per DuplicateHandle function specifications.

Remarks

In order to use this keyword with the system_handle attribute, the -target flag must be set to NT100 (or higher) when running midl.exe.

Examples

interface MyInterface : IUnknown                         
{         
    HRESULT WriteThisFile([in, system_handle(sh_file)] HANDLE file);

    HRESULT GetFileToRead([out, system_handle(sh_file, READ_CONTROL | SYNCHRONIZE | FILE_READ_DATA | FILE_READ_keywordS | FILE_READ_EA)] HANDLE* pReadThisFile);
}

Requirements

   
Minimum supported client Windows 10 Anniversary Update (version 1607, build 14393)
Minimum supported server Windows Server 2016 (build 14393)

See also

system_handle

File Security and Access Rights

DirectComposition

DCompositionCreateSurfaceHandle function