clang 19.0.0git
Public Attributes | List of all members
CXPlatformAvailability Struct Reference

Describes the availability of a given entity on a particular platform, e.g., a particular class might only be available on Mac OS 10.7 or newer. More...

#include "clang-c/Index.h"

Public Attributes

CXString Platform
 A string that describes the platform for which this structure provides availability information.
 
CXVersion Introduced
 The version number in which this entity was introduced.
 
CXVersion Deprecated
 The version number in which this entity was deprecated (but is still available).
 
CXVersion Obsoleted
 The version number in which this entity was obsoleted, and therefore is no longer available.
 
int Unavailable
 Whether the entity is unconditionally unavailable on this platform.
 
CXString Message
 An optional message to provide to a user of this API, e.g., to suggest replacement APIs.
 

Detailed Description

Describes the availability of a given entity on a particular platform, e.g., a particular class might only be available on Mac OS 10.7 or newer.

Definition at line 2449 of file Index.h.

Member Data Documentation

◆ Deprecated

CXVersion CXPlatformAvailability::Deprecated

The version number in which this entity was deprecated (but is still available).

Definition at line 2465 of file Index.h.

◆ Introduced

CXVersion CXPlatformAvailability::Introduced

The version number in which this entity was introduced.

Definition at line 2460 of file Index.h.

◆ Message

CXString CXPlatformAvailability::Message

An optional message to provide to a user of this API, e.g., to suggest replacement APIs.

Definition at line 2479 of file Index.h.

◆ Obsoleted

CXVersion CXPlatformAvailability::Obsoleted

The version number in which this entity was obsoleted, and therefore is no longer available.

Definition at line 2470 of file Index.h.

◆ Platform

CXString CXPlatformAvailability::Platform

A string that describes the platform for which this structure provides availability information.

Possible values are "ios" or "macos".

Definition at line 2456 of file Index.h.

◆ Unavailable

int CXPlatformAvailability::Unavailable

Whether the entity is unconditionally unavailable on this platform.

Definition at line 2474 of file Index.h.


The documentation for this struct was generated from the following file: