Skip to content

handletraits-structure.md

Latest commit

 

History

History
74 lines (49 loc) · 1.85 KB

handletraits-structure.md

File metadata and controls

74 lines (49 loc) · 1.85 KB
description Learn more about: HANDLETraits Structure
title HANDLETraits Structure
ms.date 09/27/2018
ms.topic reference
f1_keywords
corewrappers/Microsoft::WRL::Wrappers::HandleTraits::HANDLETraits
corewrappers/Microsoft::WRL::Wrappers::HandleTraits::HANDLETraits::Close
corewrappers/Microsoft::WRL::Wrappers::HandleTraits::HANDLETraits::GetInvalidValue
helpviewer_keywords
Microsoft::WRL::Wrappers::HandleTraits::HANDLETraits structure
Microsoft::WRL::Wrappers::HandleTraits::HANDLETraits::Close method
Microsoft::WRL::Wrappers::HandleTraits::HANDLETraits::GetInvalidValue method
ms.assetid 22963e88-d857-4624-9182-7c986daff722

HANDLETraits Structure

Defines common characteristics of a handle.

Syntax

struct HANDLETraits;

Members

Public Typedefs

Name Description
Type A synonym for HANDLE.

Public Methods

Name Description
HANDLETraits::Close Closes the specified handle.
HANDLETraits::GetInvalidValue Represents an invalid handle.

Inheritance Hierarchy

HANDLETraits

Requirements

Header: corewrappers.h

Namespace: Microsoft::WRL::Wrappers::HandleTraits

HANDLETraits::Close

Closes the specified handle.

inline static bool Close(
   _In_ Type h
);

Parameters

h
The handle to close.

Return Value

true if handle h closed successfully; otherwise, false.

HANDLETraits::GetInvalidValue

Represents an invalid handle.

inline static HANDLE GetInvalidValue();

Return Value

Always returns INVALID_HANDLE_VALUE. (INVALID_HANDLE_VALUE is defined by Windows.)